RecordHeader

java.lang.Object
- org.jlab.coda.hipo.RecordHeader

All Implemented Interfaces:: IBlockHeader

public class RecordHeader
extends java.lang.Object
implements IBlockHeader

This class represents the record header in an evio or hipo format file.



 GENERAL RECORD HEADER STRUCTURE ( 56 bytes, 14 integers (32 bit) )


    +----------------------------------+
  1 |         Record Length            | // 32bit words, inclusive
    +----------------------------------+
  2 +         Record Number            |
    +----------------------------------+
  3 +         Header Length            | // 14 (words)
    +----------------------------------+
  4 +       Event (Index) Count        |
    +----------------------------------+
  5 +      Index Array Length          | // bytes
    +-----------------------+----------+
  6 +       Bit Info        | Version  | // version (8 bits)
    +-----------------------+----------+
  7 +      User Header Length          | // bytes
    +----------------------------------+
  8 +          Magic Number            | // 0xc0da0100
    +----------------------------------+
  9 +     Uncompressed Data Length     | // bytes
    +------+---------------------------+
 10 +  CT  |  Data Length Compressed   | // CT = compression type (4 bits); compressed len in words
    +----------------------------------+
 11 +          User Register 1         | // UID 1st (64 bits)
    +--                              --+
 12 +                                  |
    +----------------------------------+
 13 +          User Register 2         | // UID 2nd (64 bits)
    +--                              --+
 14 +                                  |
    +----------------------------------+

 -------------------
   Compression Type
 -------------------
     0  = none
     1  = LZ4 fastest
     2  = LZ4 best
     3  = gzip

 -------------------
   Bit Info Word
 -------------------
     0-7  = version
     8    = true if dictionary is included (relevant for first record only)
     9    = true if this record has "first" event (to be in every split file)
    10    = true if this record is the last in file or stream
    11-14 = type of events contained: 0 = ROC Raw,
                                      1 = Physics
                                      2 = PartialPhysics
                                      3 = DisentangledPhysics
                                      4 = User
                                      5 = Control
                                     15 = Other
    15-19 = reserved
    20-21 = pad 1
    22-23 = pad 2
    24-25 = pad 3
    26-27 = reserved
    28-31 = general header type: 0 = Evio record,
                                 3 = Evio file trailer
                                 4 = HIPO record,
                                 7 = HIPO file trailer


 ------------------------------------------------------------
 ------------------------------------------------------------

   TRAILER HEADER STRUCTURE ( 56 bytes, 14 integers (32 bit) )

    +----------------------------------+
  1 |         Record Length            | // 32bit words, inclusive
    +----------------------------------+
  2 +         Record Number            |
    +----------------------------------+
  3 +               14                 |
    +----------------------------------+
  4 +                0                 |
    +----------------------------------+
  5 +      Index Array Length          | // bytes
    +-----------------------+----------+
  6 +       Bit Info        | Version  |
    +-----------------------+----------+
  7 +                0                 |
    +----------------------------------+
  8 +           0xc0da0100             |
    +----------------------------------+
  9 +     Uncompressed Data Length     | // bytes
    +----------------------------------+
 10 +                0                 |
    +----------------------------------+
 11 +                0                 |
    +--                              --+
 12 +                0                 |
    +----------------------------------+
 13 +                0                 |
    +--                              --+
 14 +                0                 |
    +----------------------------------+

 -------------------
   Bit Info Word
  bit #s  =  value
 -------------------
     0-7  = 6
     8    = 0
     9    = 0
    10    = 1
    11-14 = 0
    15-19 = 0
    20-21 = 0
    22-23 = 0
    24-25 = 0
    26-27 = 0
    28-31 = 3


 ------------------------------------------------------------

Since:: 6.0 9/6/17
Version:: 6.0
Author:: gavalian, timmer

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BIT_INFO_OFFSET` Byte offset from beginning of header to bit info word.
`static int`	`COMPRESSION_TYPE_OFFSET` Byte offset from beginning of header to the compression type and compressed data length word.
`(package private) static int`	`DATA_CONTROL_BITS` 11-14th bits in bitInfo word in record header for CODA data type, control = 5.
`(package private) static int`	`DATA_DISENTANGLED_BITS` 11-14th bits in bitInfo word in header for CODA data type, disentangled = 3.
`(package private) static int`	`DATA_OTHER_BITS` 11-14th bits in bitInfo word in record header for CODA data type, other = 15.
`(package private) static int`	`DATA_PARTIAL_BITS` 11-14th bits in bitInfo word in header for CODA data type, partial physics = 2.
`(package private) static int`	`DATA_PHYSICS_BITS` 11-14th bits in bitInfo word in header for CODA data type, physics = 1.
`(package private) static int`	`DATA_ROC_RAW_BITS` 11-14th bits in bitInfo word in header for CODA data type, ROC raw = 0.
`(package private) static int`	`DATA_USER_BITS` 11-14th bits in bitInfo word in header for CODA data type, user = 4.
`(package private) static int`	`DICTIONARY_BIT` 8th bit set in bitInfo word in header means contains dictionary.
`static int`	`EVENT_COUNT_OFFSET` Byte offset from beginning of header to the event index count.
`static int`	`HEADER_LENGTH_OFFSET` Byte offset from beginning of header to the header length.
`static int`	`HEADER_MAGIC` Magic number used to track endianness.
`static int`	`HEADER_SIZE_BYTES` Number of bytes in a normal sized header.
`static int`	`HEADER_SIZE_WORDS` Number of 32-bit words in a normal sized header.
`static int`	`INDEX_ARRAY_OFFSET` Byte offset from beginning of header to the index array length.
`(package private) static int`	`LAST_RECORD_BIT` 9th bit set in bitInfo word in header means is last in stream or file.
`static int`	`LAST_RECORD_MASK` "Last record" is 11th bit in bitInfo word.
`static int`	`MAGIC_OFFSET` Byte offset from beginning of header to the record length.
`static int`	`RECORD_LENGTH_OFFSET` Byte offset from beginning of header to the record length.
`static int`	`RECORD_NUMBER_OFFSET` Byte offset from beginning of header to the record number.
`static int`	`REGISTER1_OFFSET` Byte offset from beginning of header to the user register #1.
`static int`	`REGISTER2_OFFSET` Byte offset from beginning of header to the user register #2.
`static int`	`UNCOMPRESSED_LENGTH_OFFSET` Byte offset from beginning of header to the uncompressed data length.
`static int`	`USER_LENGTH_OFFSET` Byte offset from beginning of header to the user header length.
`static int`	`VERSION_MASK` Mask to get version number from 6th int in header.

Fields inherited from interface org.jlab.coda.jevio.IBlockHeader
MAGIC_NUMBER

Constructor Summary

Constructors
Constructor and Description
`RecordHeader()` Default, no-arg constructor.
`RecordHeader(HeaderType type)` Constructor which sets the type of header this is.
`RecordHeader(long _pos, int _l, int _e)` Constructor.
`RecordHeader(RecordHeader header)` Constructor which copies another header.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`byteBufferBinaryString(java.nio.ByteBuffer buffer)` Print out each word of the given buffer as binary, hex, and decimal.
`int`	`bytesRemaining(long position)` Gives the bytes remaining in this block (record) given a buffer position.
`static int`	`clearLastRecordBit(int i)` Clear the bit in the given arg to indicate it is NOT the last record.
`void`	`copy(RecordHeader head)` Copy the contents of the arg into this object.
`long`	`firstEventStartingPosition()` Determines where the start of the first event in this block (record) is located (bytes).
`static int`	`generateSixthWord(java.util.BitSet set)` Calculates the sixth word of this header which has the version number (6) in the lowest 8 bits and the set in the upper 24 bits.
`static int`	`generateSixthWord(java.util.BitSet bSet, int version, boolean hasDictionary, boolean isEnd, int eventType)` Calculates the sixth word of this header which has the version number (4) in the lowest 8 bits and the set in the upper 24 bits.
`static int`	`generateSixthWord(int version, boolean hasDictionary, boolean isEnd, int eventType)` Calculates the sixth word of this header which has the version number in the lowest 8 bits.
`int`	`getBitInfoWord()` Get the bit info word.
`long`	`getBufferEndingPosition()` Get the position in the buffer (bytes) of this block's last data word.
`long`	`getBufferStartingPosition()` Get the starting position in the buffer (bytes) from which this header was read--if that happened. This is not part of the block header proper.
`java.nio.ByteOrder`	`getByteOrder()` Get the byte order of the file/buffer this header was read from.
`int`	`getCompressedDataLength()` Get the length of the compressed data in bytes.
`int`	`getCompressedDataLengthPadding()` Get the padding of the compressed data in bytes.
`int`	`getCompressedDataLengthWords()` Get the length of the compressed data in words (padded).
`int`	`getCompressedRecordLength()` Get the padded length in bytes of the entire compressed record.
`CompressionType`	`getCompressionType()` Get the type of compression used.
`int`	`getDataLength()` Get the length of the uncompressed data in bytes.
`int`	`getDataLengthWords()` Get the length of the uncompressed data in words (padded).
`int`	`getEntries()` Get the number of events or entries in index.
`int`	`getEventType()` Get the type of events in block/record (see values of `DataType`.
`int`	`getHeaderLength()` Get the length of this header data in bytes (NOT including user header or index).
`HeaderType`	`getHeaderType()` Get the type of header this is.
`int`	`getHeaderWords()` Get the length of this header data in words.
`int`	`getIndexLength()` Get the length of the index array in bytes.
`int`	`getLength()` Get the total length of this record in bytes.
`int`	`getLengthWords()` Get the total length of this record in 32 bit words.
`int`	`getMagicNumber()` Get the magic number the block (record) header which should be 0xc0da0100.
`int`	`getNumber()` Get the block number for this block (record).
`long`	`getPosition()` Get the position of this record in a file.
`int`	`getRecordNumber()` Get the record number.
`int`	`getSize()` Get the size of the block (record) in 32 bit words.
`int`	`getSourceId()` Get the source ID number if in CODA online context and data is coming from ROC.
`int`	`getTotalHeaderLength()` Get the length of the regular header + index + user header (including padding) in bytes.
`int`	`getUncompressedRecordLength()` Get the padded length in bytes of the entire uncompressed record.
`int`	`getUserHeaderLength()` Get the length of the user-defined header in bytes.
`int`	`getUserHeaderLengthWords()` Get the length of the user-defined header in words.
`long`	`getUserRegisterFirst()` Get the first user-defined 64-bit register.
`long`	`getUserRegisterSecond()` Get the second user-defined 64-bit register.
`int`	`getVersion()` Get the Evio format version number.
`boolean`	`hasDictionary()` Does this record have a dictionary in the user header?
`int`	`hasDictionary(boolean hasFirst)` Set the bit which says record has a dictionary in the user header.
`static boolean`	`hasDictionary(int bitInfo)` Does this bitInfo arg indicate the existence of a dictionary in the user header?
`boolean`	`hasFirstEvent()` Does this header have a first event in the user header?
`boolean`	`isCompressed()` Does this header indicate compressed data?
`static boolean`	`isCompressed(java.nio.ByteBuffer buffer, int offset)` Quickly check to see if this buffer contains compressed data or not.
`boolean`	`isEvioRecord()` Is this header an evio record?
`static boolean`	`isEvioRecord(int bitInfo)` Does this arg indicate its header is an evio record?
`boolean`	`isEvioTrailer()` Is this header an evio trailer?
`static boolean`	`isEvioTrailer(int bitInfo)` Does this arg indicate its header is an evio trailer?
`boolean`	`isHipoRecord()` Is this header a hipo record?
`static boolean`	`isHipoRecord(int bitInfo)` Does this arg indicate its header is a hipo record?
`boolean`	`isHipoTrailer()` Is this header a hipo trailer?
`static boolean`	`isHipoTrailer(int bitInfo)` Does this arg indicate its header is a hipo trailer?
`boolean`	`isLastBlock()` Is this the last block in the file or being sent over the network?
`boolean`	`isLastRecord()` Is this the header of the last record?
`int`	`isLastRecord(boolean isLast)` Set the bit which says record is last in file/buffer.
`static boolean`	`isLastRecord(int bitInfo)` Does this word indicate this is the header of the last record?
`static void`	`main(java.lang.String[] args)` Run this class as an executable which tests the writing and reading of a record.
`long`	`nextBufferStartingPosition()` Determines where the start of the next block (record) header in some buffer is located (bytes).
`void`	`readHeader(java.nio.ByteBuffer buffer)` Reads the header information from a byte buffer and validates it by checking the magic word (8th word).
`void`	`readHeader(java.nio.ByteBuffer buffer, int offset)` Reads the header information from a byte buffer and validates it by checking the magic word (8th word).
`void`	`reset()` Reset generated data.
`int`	`setBitInfo(boolean isLastRecord, boolean haveDictionary)` Set the bit info word for a record header.
`int`	`setBitInfoEventType(int type)` Set the bit info of a record header for a specified CODA event type.
`void`	`setBitInfoWord(java.util.BitSet set)` Set the bit info word and related values.
`void`	`setBitInfoWord(int word)` Set the bit info word and related values.
`void`	`setBufferStartingPosition(long bufferStartingPosition)` Set the starting position in the buffer (bytes) from which this header was read--if that happened. This is not part of the block header proper.
`RecordHeader`	`setCompressedDataLength(int length)` Set the compressed data length in bytes and words and the padding.
`RecordHeader`	`setCompressionType(CompressionType type)` Set the compression type.
`RecordHeader`	`setDataLength(int length)` Set the uncompressed data length in bytes and words and the padding.
`RecordHeader`	`setEntries(int n)` Set the number of events or index entries.
`RecordHeader`	`setHeaderLength(int length)` Set the this header's length in bytes and words.
`(package private) RecordHeader`	`setHeaderType(HeaderType type)` Set this header's type.
`RecordHeader`	`setIndexLength(int length)` Set the length of the index array in bytes.
`RecordHeader`	`setLength(int length)` Set the record length in bytes and words.
`RecordHeader`	`setPosition(long pos)` Set the position of this record in a file.
`RecordHeader`	`setRecordNumber(int num)` Set the record number.
`RecordHeader`	`setUserHeaderLength(int length)` Set the user-defined header's length in bytes and words and the padding.
`RecordHeader`	`setUserRegisterFirst(long reg)` Set the first, 64-bit, user-defined register.
`RecordHeader`	`setUserRegisterSecond(long reg)` Set the second, 64-bit, user-defined register.
`java.lang.String`	`toString()` Returns a string representation of the record.
`int`	`write(java.nio.ByteBuffer byteBuffer)` Write myself out into a byte buffer.
`void`	`writeHeader(java.nio.ByteBuffer buffer)` Writes this header into the given byte buffer starting at the beginning.
`void`	`writeHeader(java.nio.ByteBuffer buf, int off)` Writes this header into the given byte buffer.
`static void`	`writeTrailer(byte[] array, int recordNumber, java.nio.ByteOrder order)` Writes an empty trailer into the given byte array.
`static void`	`writeTrailer(byte[] array, int off, int recordNumber, java.nio.ByteOrder order, java.util.List<java.lang.Integer> index)` Writes a trailer with an optional index array into the given byte array.
`static void`	`writeTrailer(java.nio.ByteBuffer buf, int recordNumber)` Writes an empty trailer into the given buffer.
`static void`	`writeTrailer(java.nio.ByteBuffer buf, int off, int recordNumber, java.util.List<java.lang.Integer> index)` Writes a trailer with an optional index array into the given buffer.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - HEADER_SIZE_WORDS
```
public static final int HEADER_SIZE_WORDS
```
    Number of 32-bit words in a normal sized header.
    
    See Also:
    
    Constant Field Values
  - HEADER_SIZE_BYTES
```
public static final int HEADER_SIZE_BYTES
```
    Number of bytes in a normal sized header.
    
    See Also:
    
    Constant Field Values
  - HEADER_MAGIC
```
public static final int HEADER_MAGIC
```
    Magic number used to track endianness.
    
    See Also:
    
    Constant Field Values
  - RECORD_LENGTH_OFFSET
```
public static final int RECORD_LENGTH_OFFSET
```
    Byte offset from beginning of header to the record length.
    
    See Also:
    
    Constant Field Values
  - RECORD_NUMBER_OFFSET
```
public static final int RECORD_NUMBER_OFFSET
```
    Byte offset from beginning of header to the record number.
    
    See Also:
    
    Constant Field Values
  - HEADER_LENGTH_OFFSET
```
public static final int HEADER_LENGTH_OFFSET
```
    Byte offset from beginning of header to the header length.
    
    See Also:
    
    Constant Field Values
  - EVENT_COUNT_OFFSET
```
public static final int EVENT_COUNT_OFFSET
```
    Byte offset from beginning of header to the event index count.
    
    See Also:
    
    Constant Field Values
  - INDEX_ARRAY_OFFSET
```
public static final int INDEX_ARRAY_OFFSET
```
    Byte offset from beginning of header to the index array length.
    
    See Also:
    
    Constant Field Values
  - BIT_INFO_OFFSET
```
public static final int BIT_INFO_OFFSET
```
    Byte offset from beginning of header to bit info word.
    
    See Also:
    
    Constant Field Values
  - USER_LENGTH_OFFSET
```
public static final int USER_LENGTH_OFFSET
```
    Byte offset from beginning of header to the user header length.
    
    See Also:
    
    Constant Field Values
  - MAGIC_OFFSET
```
public static final int MAGIC_OFFSET
```
    Byte offset from beginning of header to the record length.
    
    See Also:
    
    Constant Field Values
  - UNCOMPRESSED_LENGTH_OFFSET
```
public static final int UNCOMPRESSED_LENGTH_OFFSET
```
    Byte offset from beginning of header to the uncompressed data length.
    
    See Also:
    
    Constant Field Values
  - COMPRESSION_TYPE_OFFSET
```
public static final int COMPRESSION_TYPE_OFFSET
```
    Byte offset from beginning of header to the compression type and compressed data length word.
    
    See Also:
    
    Constant Field Values
  - REGISTER1_OFFSET
```
public static final int REGISTER1_OFFSET
```
    Byte offset from beginning of header to the user register #1.
    
    See Also:
    
    Constant Field Values
  - REGISTER2_OFFSET
```
public static final int REGISTER2_OFFSET
```
    Byte offset from beginning of header to the user register #2.
    
    See Also:
    
    Constant Field Values
  - DICTIONARY_BIT
```
static final int DICTIONARY_BIT
```
    8th bit set in bitInfo word in header means contains dictionary.
    
    See Also:
    
    Constant Field Values
  - LAST_RECORD_BIT
```
static final int LAST_RECORD_BIT
```
    9th bit set in bitInfo word in header means is last in stream or file.
    
    See Also:
    
    Constant Field Values
  - DATA_ROC_RAW_BITS
```
static final int DATA_ROC_RAW_BITS
```
    11-14th bits in bitInfo word in header for CODA data type, ROC raw = 0.
    
    See Also:
    
    Constant Field Values
  - DATA_PHYSICS_BITS
```
static final int DATA_PHYSICS_BITS
```
    11-14th bits in bitInfo word in header for CODA data type, physics = 1.
    
    See Also:
    
    Constant Field Values
  - DATA_PARTIAL_BITS
```
static final int DATA_PARTIAL_BITS
```
    11-14th bits in bitInfo word in header for CODA data type, partial physics = 2.
    
    See Also:
    
    Constant Field Values
  - DATA_DISENTANGLED_BITS
```
static final int DATA_DISENTANGLED_BITS
```
    11-14th bits in bitInfo word in header for CODA data type, disentangled = 3.
    
    See Also:
    
    Constant Field Values
  - DATA_USER_BITS
```
static final int DATA_USER_BITS
```
    11-14th bits in bitInfo word in header for CODA data type, user = 4.
    
    See Also:
    
    Constant Field Values
  - DATA_CONTROL_BITS
```
static final int DATA_CONTROL_BITS
```
    11-14th bits in bitInfo word in record header for CODA data type, control = 5.
    
    See Also:
    
    Constant Field Values
  - DATA_OTHER_BITS
```
static final int DATA_OTHER_BITS
```
    11-14th bits in bitInfo word in record header for CODA data type, other = 15.
    
    See Also:
    
    Constant Field Values
  - VERSION_MASK
```
public static final int VERSION_MASK
```
    Mask to get version number from 6th int in header.
    
    See Also:
    
    Constant Field Values
  - LAST_RECORD_MASK
```
public static final int LAST_RECORD_MASK
```
    "Last record" is 11th bit in bitInfo word.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - RecordHeader
```
public RecordHeader()
```
    Default, no-arg constructor.
  - RecordHeader
```
public RecordHeader(HeaderType type)
             throws HipoException
```
    Constructor which sets the type of header this is.
    
    Parameters:
    
    type - type of header this is
    
    Throws:
    
    HipoException - if type is for file
  - RecordHeader
```
public RecordHeader(RecordHeader header)
```
    Constructor which copies another header.
    
    Parameters:
    
    header - header to copy.
  - RecordHeader
```
public RecordHeader(long _pos,
                    int _l,
                    int _e)
```
    Constructor.
    
    Parameters:
    
    _pos - position in file.
    
    _l - length of record in bytes
    
    _e - number of events
- Method Detail
  - copy
```
public void copy(RecordHeader head)
```
    Copy the contents of the arg into this object.
    
    Parameters:
    
    head - object to copy
  - reset
```
public void reset()
```
    Reset generated data.
  - getUncompressedRecordLength
```
public int getUncompressedRecordLength()
```
    Get the padded length in bytes of the entire uncompressed record.
    
    Returns:
    
    padded length in bytes of the entire uncompressed record.
  - getCompressedRecordLength
```
public int getCompressedRecordLength()
```
    Get the padded length in bytes of the entire compressed record. If the data is not compressed, then this returns -1;
    
    Returns:
    
    padded length in bytes of the entire compressed record, else -1 if not compressed.
  - getByteOrder
```
public java.nio.ByteOrder getByteOrder()
```
    Get the byte order of the file/buffer this header was read from. Defaults to little endian.
    
    Specified by:
    
    getByteOrder in interface IBlockHeader
    
    Returns:
    
    byte order of the file/buffer this header was read from.
  - getPosition
```
public long getPosition()
```
    Get the position of this record in a file.
    
    Returns:
    
    position of this record in a file.
  - getLength
```
public int getLength()
```
    Get the total length of this record in bytes.
    
    Returns:
    
    total length of this record in bytes.
  - getLengthWords
```
public int getLengthWords()
```
    Get the total length of this record in 32 bit words.
    
    Returns:
    
    total length of this record in 32 bit words.
  - getEntries
```
public int getEntries()
```
    Get the number of events or entries in index.
    
    Returns:
    
    number of events or entries in index.
  - getCompressionType
```
public CompressionType getCompressionType()
```
    Get the type of compression used. Can be none, LZ4 fast, LZ4 best, or gzip.
    
    Specified by:
    
    getCompressionType in interface IBlockHeader
    
    Returns:
    
    type of compression used.
  - getUserHeaderLength
```
public int getUserHeaderLength()
```
    Get the length of the user-defined header in bytes.
    
    Returns:
    
    length of the user-defined header in bytes.
  - getUserHeaderLengthWords
```
public int getUserHeaderLengthWords()
```
    Get the length of the user-defined header in words.
    
    Returns:
    
    length of the user-defined header in words.
  - getVersion
```
public int getVersion()
```
    Get the Evio format version number.
    
    Specified by:
    
    getVersion in interface IBlockHeader
    
    Returns:
    
    Evio format version number.
  - getDataLength
```
public int getDataLength()
```
    Get the length of the uncompressed data in bytes.
    
    Returns:
    
    length of the uncompressed data in bytes.
  - getDataLengthWords
```
public int getDataLengthWords()
```
    Get the length of the uncompressed data in words (padded).
    
    Returns:
    
    length of the uncompressed data in words (padded).
  - getIndexLength
```
public int getIndexLength()
```
    Get the length of the index array in bytes.
    
    Returns:
    
    length of the index array in bytes.
  - getCompressedDataLength
```
public int getCompressedDataLength()
```
    Get the length of the compressed data in bytes.
    
    Returns:
    
    length of the compressed data in bytes.
  - getCompressedDataLengthPadding
```
public int getCompressedDataLengthPadding()
```
    Get the padding of the compressed data in bytes.
    
    Returns:
    
    padding of the compressed data in bytes.
  - getCompressedDataLengthWords
```
public int getCompressedDataLengthWords()
```
    Get the length of the compressed data in words (padded).
    
    Returns:
    
    length of the compressed data in words (padded).
  - getHeaderLength
```
public int getHeaderLength()
```
    Get the length of this header data in bytes (NOT including user header or index).
    
    Returns:
    
    length of this header data in bytes.
  - getHeaderWords
```
public int getHeaderWords()
```
    Get the length of this header data in words.
    
    Specified by:
    
    getHeaderWords in interface IBlockHeader
    
    Returns:
    
    length of this header data in words.
  - getTotalHeaderLength
```
public int getTotalHeaderLength()
```
    Get the length of the regular header + index + user header (including padding) in bytes. This will be a multiple of 4.
    
    Returns:
    
    length of the regular header + index + user header + user header padding in bytes.
  - getRecordNumber
```
public int getRecordNumber()
```
    Get the record number.
    
    Returns:
    
    record number.
  - getUserRegisterFirst
```
public long getUserRegisterFirst()
```
    Get the first user-defined 64-bit register.
    
    Returns:
    
    first user-defined 64-bit register.
  - getUserRegisterSecond
```
public long getUserRegisterSecond()
```
    Get the second user-defined 64-bit register.
    
    Returns:
    
    second user-defined 64-bit register.
  - getHeaderType
```
public HeaderType getHeaderType()
```
    Get the type of header this is.
    
    Returns:
    
    type of header this is.
  - setBitInfo
```
public int setBitInfo(boolean isLastRecord,
                      boolean haveDictionary)
```
    Set the bit info word for a record header. Current value of bitInfo is lost.
    
    Parameters:
    
    isLastRecord - true if record is last in stream or file.
    
    haveDictionary - true if record has dictionary in user header.
    
    Returns:
    
    new bit info word.
  - getBitInfoWord
```
public int getBitInfoWord()
```
    Get the bit info word. Will initialize if not already done.
    
    Returns:
    
    bit info word.
  - setBitInfoWord
```
public void setBitInfoWord(int word)
```
    Set the bit info word and related values. NOT FOR GENERAL USE!
    
    Parameters:
    
    word - bit info word.
  - setBitInfoWord
```
public void setBitInfoWord(java.util.BitSet set)
```
    Set the bit info word and related values. NOT FOR GENERAL USE!
    
    Parameters:
    
    set - bit info object.
  - generateSixthWord
```
public static int generateSixthWord(java.util.BitSet set)
```
    Calculates the sixth word of this header which has the version number (6) in the lowest 8 bits and the set in the upper 24 bits. NOT FOR GENERAL USE!
    
    Parameters:
    
    set - Bitset containing all bits to be set
    
    Returns:
    
    generated sixth word of this header.
  - generateSixthWord
```
public static int generateSixthWord(int version,
                                    boolean hasDictionary,
                                    boolean isEnd,
                                    int eventType)
```
    Calculates the sixth word of this header which has the version number in the lowest 8 bits. The arg hasDictionary is set in the 9th bit and isEnd is set in the 10th bit. Four bits of an int (event type) are set in bits 11-14.
    
    Parameters:
    
    version - evio version number
    
    hasDictionary - does this block include an evio xml dictionary as the first event?
    
    isEnd - is this the last block of a file or a buffer?
    
    eventType - 4 bit type of events header is containing
    
    Returns:
    
    generated sixth word of this header.
  - generateSixthWord
```
public static int generateSixthWord(java.util.BitSet bSet,
                                    int version,
                                    boolean hasDictionary,
                                    boolean isEnd,
                                    int eventType)
```
    Calculates the sixth word of this header which has the version number (4) in the lowest 8 bits and the set in the upper 24 bits. The arg isDictionary is set in the 9th bit and isEnd is set in the 10th bit. Four bits of an int (event type) are set in bits 11-14.
    
    Parameters:
    
    bSet - Bitset containing all bits to be set
    
    version - evio version number
    
    hasDictionary - does this block include an evio xml dictionary as the first event?
    
    isEnd - is this the last block of a file or a buffer?
    
    eventType - 4 bit type of events header is containing
    
    Returns:
    
    generated sixth word of this header.
  - hasFirstEvent
```
public boolean hasFirstEvent()
```
    Does this header have a first event in the user header?
    
    Specified by:
    
    hasFirstEvent in interface IBlockHeader
    
    Returns:
    
    true if header has a first event in the user header, else false.
  - hasDictionary
```
public int hasDictionary(boolean hasFirst)
```
    Set the bit which says record has a dictionary in the user header.
    
    Parameters:
    
    hasFirst - true if record has a dictionary in the user header.
    
    Returns:
    
    new bitInfo word.
  - hasDictionary
```
public boolean hasDictionary()
```
    Does this record have a dictionary in the user header?
    
    Specified by:
    
    hasDictionary in interface IBlockHeader
    
    Returns:
    
    true if record has a dictionary in the user header, else false.
  - hasDictionary
```
public static boolean hasDictionary(int bitInfo)
```
    Does this bitInfo arg indicate the existence of a dictionary in the user header?
    
    Parameters:
    
    bitInfo - bitInfo word.
    
    Returns:
    
    true if header has a dictionary in the user header, else false.
  - isLastRecord
```
public int isLastRecord(boolean isLast)
```
    Set the bit which says record is last in file/buffer.
    
    Parameters:
    
    isLast - true if record is last in file/buffer.
    
    Returns:
    
    new bitInfo word.
  - isLastRecord
```
public boolean isLastRecord()
```
    Is this the header of the last record?
    
    Returns:
    
    true this is the header of the last record, else false.
  - isLastRecord
```
public static boolean isLastRecord(int bitInfo)
```
    Does this word indicate this is the header of the last record?
    
    Parameters:
    
    bitInfo - bitInfo word.
    
    Returns:
    
    true this is the header of the last record, else false.
  - isCompressed
```
public boolean isCompressed()
```
    Does this header indicate compressed data?
    
    Specified by:
    
    isCompressed in interface IBlockHeader
    
    Returns:
    
    true if header indicates compressed data, else false.
  - isEvioTrailer
```
public boolean isEvioTrailer()
```
    Is this header an evio trailer?
    
    Returns:
    
    true if this is an evio trailer, else false.
  - isHipoTrailer
```
public boolean isHipoTrailer()
```
    Is this header a hipo trailer?
    
    Returns:
    
    true if this is a hipo trailer, else false.
  - isEvioRecord
```
public boolean isEvioRecord()
```
    Is this header an evio record?
    
    Returns:
    
    true if this is an evio record, else false.
  - isHipoRecord
```
public boolean isHipoRecord()
```
    Is this header a hipo record?
    
    Returns:
    
    true if this is a hipo record, else false.
  - isEvioTrailer
```
public static boolean isEvioTrailer(int bitInfo)
```
    Does this arg indicate its header is an evio trailer?
    
    Parameters:
    
    bitInfo - bitInfo word.
    
    Returns:
    
    true if arg represents an evio trailer, else false.
  - isHipoTrailer
```
public static boolean isHipoTrailer(int bitInfo)
```
    Does this arg indicate its header is a hipo trailer?
    
    Parameters:
    
    bitInfo - bitInfo word.
    
    Returns:
    
    true if arg represents a hipo trailer, else false.
  - isEvioRecord
```
public static boolean isEvioRecord(int bitInfo)
```
    Does this arg indicate its header is an evio record?
    
    Parameters:
    
    bitInfo - bitInfo word.
    
    Returns:
    
    true if arg represents an evio record, else false.
  - isHipoRecord
```
public static boolean isHipoRecord(int bitInfo)
```
    Does this arg indicate its header is a hipo record?
    
    Parameters:
    
    bitInfo - bitInfo word.
    
    Returns:
    
    true if arg represents a hipo record, else false.
  - clearLastRecordBit
```
public static int clearLastRecordBit(int i)
```
    Clear the bit in the given arg to indicate it is NOT the last record.
    
    Parameters:
    
    i - integer in which to clear the last-record bit
    
    Returns:
    
    arg with last-record bit cleared
  - setBitInfoEventType
```
public int setBitInfoEventType(int type)
```
    Set the bit info of a record header for a specified CODA event type. Must be called AFTER setBitInfo(boolean, boolean) or setBitInfoWord(int) in order to have change preserved.
    
    Parameters:
    
    type - event type (0=ROC raw, 1=Physics, 2=Partial Physics, 3=Disentangled, 4=User, 5=Control, 15=Other, else = nothing set).
    
    Returns:
    
    new bit info word.
  - setHeaderType
```
RecordHeader setHeaderType(HeaderType type)
```
    Set this header's type. Normally done in constructor. Limited access.
    
    Parameters:
    
    type - type of header.
    
    Returns:
    
    this object.
  - setPosition
```
public RecordHeader setPosition(long pos)
```
    Set the position of this record in a file.
    
    Parameters:
    
    pos - position of this record in a file.
    
    Returns:
    
    this object.
  - setRecordNumber
```
public RecordHeader setRecordNumber(int num)
```
    Set the record number.
    
    Parameters:
    
    num - record number.
    
    Returns:
    
    this object.
  - setLength
```
public RecordHeader setLength(int length)
```
    Set the record length in bytes and words. If length is not a multiple of 4, you're on your own!
    
    Parameters:
    
    length - length of record in bytes.
    
    Returns:
    
    this object.
  - setDataLength
```
public RecordHeader setDataLength(int length)
```
    Set the uncompressed data length in bytes and words and the padding.
    
    Parameters:
    
    length - length of uncompressed data in bytes.
    
    Returns:
    
    this object.
  - setCompressedDataLength
```
public RecordHeader setCompressedDataLength(int length)
```
    Set the compressed data length in bytes and words and the padding.
    
    Parameters:
    
    length - length of compressed data in bytes.
    
    Returns:
    
    this object.
  - setIndexLength
```
public RecordHeader setIndexLength(int length)
```
    Set the length of the index array in bytes. Length is forced to be a multiple of 4!
    
    Parameters:
    
    length - length of index array in bytes.
    
    Returns:
    
    this object.
  - setCompressionType
```
public RecordHeader setCompressionType(CompressionType type)
```
    Set the compression type. 0=none, 1=LZ4 fast, 2=LZ4 best, 3=gzip. No compression for other values.
    
    Parameters:
    
    type - compression type.
    
    Returns:
    
    this object.
  - setEntries
```
public RecordHeader setEntries(int n)
```
    Set the number of events or index entries. No compression for other values.
    
    Parameters:
    
    n - number of events or index entries.
    
    Returns:
    
    this object.
  - setUserHeaderLength
```
public RecordHeader setUserHeaderLength(int length)
```
    Set the user-defined header's length in bytes and words and the padding.
    
    Parameters:
    
    length - user-defined header's length in bytes.
    
    Returns:
    
    this object.
  - setHeaderLength
```
public RecordHeader setHeaderLength(int length)
```
    Set the this header's length in bytes and words. If length is not a multiple of 4, you're on your own!
    
    Parameters:
    
    length - this header's length in bytes.
    
    Returns:
    
    this object.
  - setUserRegisterFirst
```
public RecordHeader setUserRegisterFirst(long reg)
```
    Set the first, 64-bit, user-defined register.
    
    Parameters:
    
    reg - first, 64-bit, user-defined register.
    
    Returns:
    
    this object.
  - setUserRegisterSecond
```
public RecordHeader setUserRegisterSecond(long reg)
```
    Set the second, 64-bit, user-defined register.
    
    Parameters:
    
    reg - second, 64-bit, user-defined register.
    
    Returns:
    
    this object.
  - writeHeader
```
public void writeHeader(java.nio.ByteBuffer buf,
                        int off)
                 throws HipoException
```
    Writes this header into the given byte buffer. Position and limit of given buffer does NOT change.
    
    Parameters:
    
    buf - byte buffer to write header into.
    
    off - position in buffer to begin writing.
    
    Throws:
    
    HipoException - if buffer is null or contains too little room.
  - writeHeader
```
public void writeHeader(java.nio.ByteBuffer buffer)
                 throws HipoException
```
    Writes this header into the given byte buffer starting at the beginning. Position and limit of given buffer does NOT change.
    
    Parameters:
    
    buffer - byte buffer to write header into.
    
    Throws:
    
    HipoException - if buffer arg is null, contains too little room.
  - writeTrailer
```
public static void writeTrailer(byte[] array,
                                int recordNumber,
                                java.nio.ByteOrder order)
                         throws HipoException
```
    Writes an empty trailer into the given byte array.
    
    Parameters:
    
    array - byte array to write trailer into.
    
    recordNumber - record number of trailer.
    
    order - byte order of data to be written.
    
    Throws:
    
    HipoException - if array arg is null or too small to hold trailer
  - writeTrailer
```
public static void writeTrailer(byte[] array,
                                int off,
                                int recordNumber,
                                java.nio.ByteOrder order,
                                java.util.List<java.lang.Integer> index)
                         throws HipoException
```
    Writes a trailer with an optional index array into the given byte array.
    
    Parameters:
    
    array - byte array to write trailer into.
    
    off - offset into array to start writing.
    
    recordNumber - record number of trailer.
    
    order - byte order of data to be written.
    
    index - list of record lengths interspersed with event counts to be written to trailer. Null if no index list.
    
    Throws:
    
    HipoException - if array arg is null, array too small to hold trailer + index.
  - writeTrailer
```
public static void writeTrailer(java.nio.ByteBuffer buf,
                                int off,
                                int recordNumber,
                                java.util.List<java.lang.Integer> index)
                         throws HipoException
```
    Writes a trailer with an optional index array into the given buffer. Buffer's limit and position will set ready to read again after this method called.
    
    Parameters:
    
    buf - ByteBuffer to write trailer into.
    
    off - offset into buffer to start writing.
    
    recordNumber - record number of trailer.
    
    index - list of record lengths interspersed with event counts to be written to trailer. Null if no index list.
    
    Throws:
    
    HipoException - if buf arg is null, buf too small to hold trailer + index.
  - writeTrailer
```
public static void writeTrailer(java.nio.ByteBuffer buf,
                                int recordNumber)
                         throws HipoException
```
    Writes an empty trailer into the given buffer.
    
    Parameters:
    
    buf - ByteBuffer to write trailer into.
    
    recordNumber - record number of trailer.
    
    Throws:
    
    HipoException - if buf arg is null or too small to hold trailer
  - isCompressed
```
public static boolean isCompressed(java.nio.ByteBuffer buffer,
                                   int offset)
                            throws HipoException
```
    Quickly check to see if this buffer contains compressed data or not. The offset must point to the beginning of a valid hipo/evio record in the buffer.
    
    Parameters:
    
    buffer - buffer to read from.
    
    offset - position of record header to be read.
    
    Returns:
    
    true if data in record is compressed, else false.
    
    Throws:
    
    HipoException - if buffer is null, contains too little data, or is not in proper format.
  - readHeader
```
public void readHeader(java.nio.ByteBuffer buffer,
                       int offset)
                throws HipoException
```
    Reads the header information from a byte buffer and validates it by checking the magic word (8th word). This magic word also determines the byte order.
    
    Parameters:
    
    buffer - buffer to read from.
    
    offset - position of first word to be read.
    
    Throws:
    
    HipoException - if buffer is null, contains too little data, is not in proper format, or version earlier than 6.
  - readHeader
```
public void readHeader(java.nio.ByteBuffer buffer)
                throws HipoException
```
    Reads the header information from a byte buffer and validates it by checking the magic word (8th word). This magic word also determines the byte order.
    
    Parameters:
    
    buffer - buffer to read from starting at beginning.
    
    Throws:
    
    HipoException - if buffer is not in the proper format or earlier than version 6
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of the record.
    
    Specified by:
    
    toString in interface IBlockHeader
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a string representation of the record.
  - getSize
```
public int getSize()
```
    Get the size of the block (record) in 32 bit words.
    
    Specified by:
    
    getSize in interface IBlockHeader
    
    Returns:
    
    size of the block (record) in 32 bit words.
  - getNumber
```
public int getNumber()
```
    Get the block number for this block (record). In a file, this is usually sequential.
    
    Specified by:
    
    getNumber in interface IBlockHeader
    
    Returns:
    
    the block number for this block (record).
  - getMagicNumber
```
public int getMagicNumber()
```
    Get the magic number the block (record) header which should be 0xc0da0100.
    
    Specified by:
    
    getMagicNumber in interface IBlockHeader
    
    Returns:
    
    magic number in the block (record).
  - isLastBlock
```
public boolean isLastBlock()
```
    Is this the last block in the file or being sent over the network?
    
    Specified by:
    
    isLastBlock in interface IBlockHeader
    
    Returns:
    
    true if this is the last block in the file or being sent over the network, else false.
  - getSourceId
```
public int getSourceId()
```
    Get the source ID number if in CODA online context and data is coming from ROC.
    
    Specified by:
    
    getSourceId in interface IBlockHeader
    
    Returns:
    
    source ID number if in CODA online context and data is coming from ROC.
  - getEventType
```
public int getEventType()
```
    Get the type of events in block/record (see values of DataType.
    
    Specified by:
    
    getEventType in interface IBlockHeader
    
    Returns:
    
    type of events in block/record.
  - write
```
public int write(java.nio.ByteBuffer byteBuffer)
```
    Write myself out into a byte buffer. This write is relative--i.e., it uses the current position of the buffer.
    
    Specified by:
    
    write in interface IBlockHeader
    
    Parameters:
    
    byteBuffer - the byteBuffer to write to.
    
    Returns:
    
    the number of bytes written.
  - getBufferEndingPosition
```
public long getBufferEndingPosition()
```
    Get the position in the buffer (bytes) of this block's last data word.
    
    Specified by:
    
    getBufferEndingPosition in interface IBlockHeader
    
    Returns:
    
    position in the buffer (bytes) of this block's last data word.
  - getBufferStartingPosition
```
public long getBufferStartingPosition()
```
    Get the starting position in the buffer (bytes) from which this header was read--if that happened.
    This is not part of the block header proper. It is a position in a memory buffer of the start of the block (record). It is kept for convenience. It is up to the reader to set it.
    
    Specified by:
    
    getBufferStartingPosition in interface IBlockHeader
    
    Returns:
    
    starting position in buffer (bytes) from which this header was read--if that happened.
  - setBufferStartingPosition
```
public void setBufferStartingPosition(long bufferStartingPosition)
```
    Set the starting position in the buffer (bytes) from which this header was read--if that happened.
    This is not part of the block header proper. It is a position in a memory buffer of the start of the block (record). It is kept for convenience. It is up to the reader to set it.
    
    Specified by:
    
    setBufferStartingPosition in interface IBlockHeader
    
    Parameters:
    
    bufferStartingPosition - starting position in buffer from which this header was read--if that happened.
  - nextBufferStartingPosition
```
public long nextBufferStartingPosition()
```
    Determines where the start of the next block (record) header in some buffer is located (bytes). This assumes the start position has been maintained by the object performing the buffer read.
    
    Specified by:
    
    nextBufferStartingPosition in interface IBlockHeader
    
    Returns:
    
    the start of the next block (record) header in some buffer is located (bytes).
  - firstEventStartingPosition
```
public long firstEventStartingPosition()
```
    Determines where the start of the first event in this block (record) is located (bytes). This assumes the start position has been maintained by the object performing the buffer read.
    
    Specified by:
    
    firstEventStartingPosition in interface IBlockHeader
    
    Returns:
    
    where the start of the first event in this block (record) is located (bytes). In evio format version 2, returns 0 if start is 0, signaling that this entire record is part of a logical record that spans at least three physical records.
  - bytesRemaining
```
public int bytesRemaining(long position)
                   throws EvioException
```
    Gives the bytes remaining in this block (record) given a buffer position. The position is an absolute position in a byte buffer. This assumes that the absolute position in bufferStartingPosition is being maintained properly by the reader. No block is longer than 2.1GB - 31 bits of length. This is for practical reasons - so a block can be read into a single byte array.
    
    Specified by:
    
    bytesRemaining in interface IBlockHeader
    
    Parameters:
    
    position - the absolute current position in a byte buffer.
    
    Returns:
    
    the number of bytes remaining in this block (record).
    
    Throws:
    
    EvioException - if position out of bounds
  - byteBufferBinaryString
```
public static void byteBufferBinaryString(java.nio.ByteBuffer buffer)
```
    Print out each word of the given buffer as binary, hex, and decimal.
    
    Parameters:
    
    buffer - byffer to print out.
  - main
```
public static void main(java.lang.String[] args)
```
    Run this class as an executable which tests the writing and reading of a record.
    
    Parameters:
    
    args - args.

Class RecordHeader

Field Summary

Fields inherited from interface org.jlab.coda.jevio.IBlockHeader

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

HEADER_SIZE_WORDS

HEADER_SIZE_BYTES

HEADER_MAGIC

RECORD_LENGTH_OFFSET

RECORD_NUMBER_OFFSET

HEADER_LENGTH_OFFSET

EVENT_COUNT_OFFSET

INDEX_ARRAY_OFFSET

BIT_INFO_OFFSET

USER_LENGTH_OFFSET

MAGIC_OFFSET

UNCOMPRESSED_LENGTH_OFFSET

COMPRESSION_TYPE_OFFSET

REGISTER1_OFFSET

REGISTER2_OFFSET

DICTIONARY_BIT

LAST_RECORD_BIT

DATA_ROC_RAW_BITS

DATA_PHYSICS_BITS

DATA_PARTIAL_BITS

DATA_DISENTANGLED_BITS

DATA_USER_BITS

DATA_CONTROL_BITS

DATA_OTHER_BITS

VERSION_MASK

LAST_RECORD_MASK

Constructor Detail

RecordHeader

RecordHeader

RecordHeader

RecordHeader

Method Detail

copy

reset

getUncompressedRecordLength

getCompressedRecordLength

getByteOrder

getPosition

getLength

getLengthWords

getEntries

getCompressionType

getUserHeaderLength

getUserHeaderLengthWords

getVersion

getDataLength

getDataLengthWords

getIndexLength

getCompressedDataLength

getCompressedDataLengthPadding

getCompressedDataLengthWords

getHeaderLength

getHeaderWords

getTotalHeaderLength

getRecordNumber

getUserRegisterFirst

getUserRegisterSecond

getHeaderType

setBitInfo

getBitInfoWord

setBitInfoWord

setBitInfoWord

generateSixthWord

generateSixthWord

generateSixthWord

hasFirstEvent

hasDictionary

hasDictionary

hasDictionary

isLastRecord

isLastRecord

isLastRecord

isCompressed