|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.jlab.coda.jevio.BaseStructure org.jlab.coda.jevio.EvioSegment
public class EvioSegment
This holds a CODA Segment structure. Mostly it has a header (a SegementHeader
) and the raw data stored as an
byte array.
Field Summary | |
---|---|
static java.lang.String |
ELEMENT_NAME
The XML record tag for a segment. |
Constructor Summary | |
---|---|
EvioSegment()
Null constructor creates an empty SegmentHeader. |
|
EvioSegment(int tag,
DataType dataType)
This is the general constructor to use for a Segment. |
|
EvioSegment(SegmentHeader segmentHeader)
Constructor using a provided SegmentHeader |
Method Summary | |
---|---|
StructureType |
getStructureType()
This implements the abstract method from BaseStructure . |
java.lang.String |
getXMLElementName()
Get the element name for the bank for writing to XML. |
void |
toXML(javax.xml.stream.XMLStreamWriter xmlWriter)
Write this segment structure out as an XML record. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String ELEMENT_NAME
Constructor Detail |
---|
public EvioSegment()
SegmentHeader
public EvioSegment(SegmentHeader segmentHeader)
segmentHeader
- the header to use.SegmentHeader
public EvioSegment(int tag, DataType dataType)
tag
- the tag for the segment header.dataType
- the (enum) data type for the content of the segment.Method Detail |
---|
public StructureType getStructureType()
BaseStructure
. It is a convenience method use instead of
"instanceof" to see what type of structure we have. Note: this returns the type of this structure, not the type
of data this structure holds.
getStructureType
in interface IEvioStructure
getStructureType
in class BaseStructure
StructureType
of this structure, which is a StructureType.SEGMENT.StructureType
public void toXML(javax.xml.stream.XMLStreamWriter xmlWriter)
toXML
in class BaseStructure
xmlWriter
- the writer used to write the events.public java.lang.String getXMLElementName()
getXMLElementName
in class BaseStructure
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |