IBlockHeader

All Known Implementing Classes:

BlockHeaderV2, BlockHeaderV4, RecordHeader
```
public interface IBlockHeader
```
Make a common interface for different versions of the BlockHeader.

Author:

timmer

Field Summary

Fields
Modifier and Type Field and Description

static int MAGIC_NUMBER
The magic number, should be the value of magicNumber.

Fields
Modifier and Type	Field and Description
`static int`	`MAGIC_NUMBER` The magic number, should be the value of `magicNumber`.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`int`	`bytesRemaining(long position)` Gives the bytes remaining in this block (record) given a buffer position.
`long`	`firstEventStartingPosition()` Determines where the start of the first event in this block (record) is located (bytes).
`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 data being read.
`CompressionType`	`getCompressionType()` Get the type of data compression used.
`int`	`getEventType()` Get the type of events in block/record (see values of `DataType`.
`int`	`getHeaderWords()` Get the block (record) header length, 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).
`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`	`getVersion()` Get the evio version of the block (record) header.
`boolean`	`hasDictionary()` Does this block contain an evio dictionary?
`boolean`	`hasFirstEvent()` Does this block/record contain the "first event" (first event to be written to each file split)?
`boolean`	`isCompressed()` Is this the data in this block compressed?
`boolean`	`isLastBlock()` Is this the last block in the file or being sent over the network?
`long`	`nextBufferStartingPosition()` Determines where the start of the next block (record) header in some buffer is located (bytes).
`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.
`java.lang.String`	`toString()` Get the string representation of the block (record) header.
`int`	`write(java.nio.ByteBuffer byteBuffer)` Write myself out into a byte buffer.

- Field Detail
  - MAGIC_NUMBER
```
static final int MAGIC_NUMBER
```
    The magic number, should be the value of magicNumber.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getSize
```
int getSize()
```
    Get the size of the block (record) in 32 bit words.
    
    Returns:
    
    size of the block (record) in 32 bit words.
  - getNumber
```
int getNumber()
```
    Get the block number for this block (record). In a file, this is usually sequential.
    
    Returns:
    
    the block number for this block (record).
  - getHeaderWords
```
int getHeaderWords()
```
    Get the block (record) header length, in 32 bit words.
    
    Returns:
    
    block (record) header length, in 32 bit words.
  - getSourceId
```
int getSourceId()
```
    Get the source ID number if in CODA online context and data is coming from ROC.
    
    Returns:
    
    source ID number if in CODA online context and data is coming from ROC.
  - hasFirstEvent
```
boolean hasFirstEvent()
```
    Does this block/record contain the "first event" (first event to be written to each file split)?
    
    Returns:
    
    true if this record has the first event, else false
  - getEventType
```
int getEventType()
```
    Get the type of events in block/record (see values of DataType.
    
    Returns:
    
    type of events in block/record.
  - getVersion
```
int getVersion()
```
    Get the evio version of the block (record) header.
    
    Returns:
    
    evio version of the block (record) header.
  - getMagicNumber
```
int getMagicNumber()
```
    Get the magic number the block (record) header which should be 0xc0da0100.
    
    Returns:
    
    magic number in the block (record).
  - getByteOrder
```
java.nio.ByteOrder getByteOrder()
```
    Get the byte order of the data being read.
    
    Returns:
    
    byte order of the data being read.
  - getBufferEndingPosition
```
long getBufferEndingPosition()
```
    Get the position in the buffer (bytes) of this block's last data word.
    
    Returns:
    
    position in the buffer (bytes) of this block's last data word.
  - getBufferStartingPosition
```
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.
    
    Returns:
    
    starting position in buffer (bytes) from which this header was read--if that happened.
  - setBufferStartingPosition
```
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.
    
    Parameters:
    
    bufferStartingPosition - starting position in buffer from which this header was read--if that happened.
  - nextBufferStartingPosition
```
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.
    
    Returns:
    
    the start of the next block (record) header in some buffer is located (bytes).
  - firstEventStartingPosition
```
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.
    
    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
```
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.
    
    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
  - hasDictionary
```
boolean hasDictionary()
```
    Does this block contain an evio dictionary?
    
    Returns:
    
    true if this block contains an evio dictionary, else false.
  - isLastBlock
```
boolean isLastBlock()
```
    Is this the last block in the file or being sent over the network?
    
    Returns:
    
    true if this is the last block in the file or being sent over the network, else false.
  - isCompressed
```
boolean isCompressed()
```
    Is this the data in this block compressed?
    
    Returns:
    
    true if the data in this block is compressed, else false.
  - getCompressionType
```
CompressionType getCompressionType()
```
    Get the type of data compression used.
    
    Returns:
    
    type of data compression used.
  - write
```
int write(java.nio.ByteBuffer byteBuffer)
   throws java.nio.BufferOverflowException
```
    Write myself out into a byte buffer. This write is relative--i.e., it uses the current position of the buffer.
    
    Parameters:
    
    byteBuffer - the byteBuffer to write to.
    
    Returns:
    
    the number of bytes written.
    
    Throws:
    
    java.nio.BufferOverflowException - if insufficient room to write header into buffer.
  - toString
```
java.lang.String toString()
```
    Get the string representation of the block (record) header.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    string representation of the block (record) header.

Interface IBlockHeader

Field Summary

Method Summary

Field Detail

MAGIC_NUMBER

Method Detail

getSize

getNumber

getHeaderWords

getSourceId

hasFirstEvent

getEventType

getVersion

getMagicNumber

getByteOrder

getBufferEndingPosition

getBufferStartingPosition

setBufferStartingPosition

nextBufferStartingPosition

firstEventStartingPosition

bytesRemaining

hasDictionary

isLastBlock

isCompressed

getCompressionType

write

toString