|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jlab.coda.jevio.BaseStructureHeader
public abstract class BaseStructureHeader
This the header for the base structure (BaseStructure
). It does not contain the raw data, just the
header. The three headers for the actual structures found in evio (BANK, SEGMENT, and TAGSEMENT) all extend this.
Constructor Summary | |
---|---|
BaseStructureHeader()
Null constructor. |
|
BaseStructureHeader(int tag,
DataType dataType)
Constructor |
|
BaseStructureHeader(int tag,
DataType dataType,
int num)
Constructor |
|
BaseStructureHeader(int tag,
int dataType)
Constructor |
|
BaseStructureHeader(int tag,
int dataType,
int num)
Constructor |
Method Summary | |
---|---|
byte |
byteValue(java.lang.Integer integer)
Convenience method to return the byte value of an integer. |
int |
getDataType()
Get the data type for the structure. |
DataType |
getDataTypeEnum()
Returns the data type for data stored in this structure as a DataType enum. |
java.lang.String |
getDataTypeName()
Returns the data type as a string. |
abstract int |
getHeaderLength()
Get the length of the structure's header in ints. |
int |
getLength()
Get the length of the structure in ints, not counting the length word. |
int |
getNumber()
Get the number. |
int |
getTag()
Get the structure tag. |
void |
setDataType(int dataType)
Set the numeric data type for the structure. |
void |
setLength(int length)
Set the length of the structure in ints, not counting the length word. |
void |
setNumber(int number)
Set the number. |
void |
setTag(int tag)
Set the structure tag. |
short |
shortValue(java.lang.Integer integer)
Convenience method to return the short value of an integer. |
java.lang.String |
toString()
Obtain a string representation of the structure header. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.jlab.coda.jevio.IEvioWriter |
---|
write |
Constructor Detail |
---|
public BaseStructureHeader()
public BaseStructureHeader(int tag, DataType dataType)
tag
- the tag for the header.dataType
- the enum data type for the content of the structure.public BaseStructureHeader(int tag, int dataType)
tag
- the tag for the header.dataType
- the (int) data type for the content of the structure.public BaseStructureHeader(int tag, DataType dataType, int num)
tag
- the tag for the header.dataType
- the data type for the content of the structure.num
- sometimes, but not necessarily, an ordinal enumeration.public BaseStructureHeader(int tag, int dataType, int num)
tag
- the tag for the event header.dataType
- the (int) data type for the content of the structure.num
- sometimes, but not necessarily, an ordinal enumeration.Method Detail |
---|
public int getNumber()
public void setNumber(int number)
number
- the number.public int getDataType()
public void setDataType(int dataType)
dataType
- the dataTtype for the structure.public int getLength()
public void setLength(int length)
length
- the length of the structure in ints, not counting the length word.public abstract int getHeaderLength()
public int getTag()
public void setTag(int tag)
tag
- the structure tag.public java.lang.String getDataTypeName()
public DataType getDataTypeEnum()
DataType
enum.
DataType
enum.DataType
public java.lang.String toString()
toString
in class java.lang.Object
public byte byteValue(java.lang.Integer integer)
integer
- the integer whose byte value is needed. Can pass in a primitive int.
public short shortValue(java.lang.Integer integer)
integer
- the integer whose short value is needed. Can pass in a primitive int.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |