HipoRecordHeader

Documentation of 'org.jlab.hipo.io.HipoRecordHeader' Java class HipoRecordHeader

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- org.jlab.hipo.io.HipoRecordHeader

public class HipoRecordHeader
extends java.lang.Object

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`OFFSET_DATA_LENGTH_WORD_COMPRESSED`
`static int`	`OFFSET_DATA_LENGTH_WORD_UNCOMPRESSED`
`static int`	`OFFSET_HEADER_LENGTH_WORD`
`static int`	`OFFSET_INDEX_LENGTH_WORD`
`static int`	`OFFSET_NUMBER_OF_EVENTS`
`static int`	`OFFSET_RECORD_LENGTH_WORD` Define offsets for each WORD in the header
`static int`	`RECORD_HEADER_SIZE`
`static int`	`RECORD_IDENTIFIER_INTEGER`
`static byte[]`	`RECORD_IDENTIFIER_STRING`

Constructor Summary

Constructors
Constructor and Description

HipoRecordHeader()

HipoRecordHeader(byte[] array)

Constructors
Constructor and Description
`HipoRecordHeader()`
`HipoRecordHeader(byte[] array)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getCompressionType()`
`int`	`getDataSize()`
`int`	`getDataSizeCompressed()`
`int`	`getHeaderSize()`
`int`	`getIndexArraySize()`
`int`	`getNumberOfEvents()`
`long`	`getPositionInFile()`
`byte[]`	`getRecordHeaderData()`
`int`	`getRecordHeaderLength()`
`int`	`getRecordSize()`
`void`	`initBinary(byte[] array)`
`boolean`	`isValid()`
`static void`	`main(java.lang.String[] args)`
`void`	`reset()`
`void`	`setCompressionType(int type)`
`void`	`setDataSize(int size)`
`void`	`setDataSizeCompressed(int size)`
`void`	`setHeaderSize(int size)`
`void`	`setIndexArraySize(int size)`
`void`	`setNumberOfEvents(int nevents)`
`void`	`setPositionInFile(long pos)`
`void`	`setRecordHeaderLength(int length)`
`void`	`setRecordSize(int size)`
`java.lang.String`	`toString()`

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

Field Detail
- RECORD_HEADER_SIZE
```
public static final int RECORD_HEADER_SIZE
```
  See Also:
  
  Constant Field Values
- RECORD_IDENTIFIER_STRING
```
public static final byte[] RECORD_IDENTIFIER_STRING
```
- RECORD_IDENTIFIER_INTEGER
```
public static final int RECORD_IDENTIFIER_INTEGER
```
  See Also:
  
  Constant Field Values
- OFFSET_RECORD_LENGTH_WORD
```
public static final int OFFSET_RECORD_LENGTH_WORD
```
  Define offsets for each WORD in the header
  
  See Also:
  
  Constant Field Values
- OFFSET_DATA_LENGTH_WORD_UNCOMPRESSED
```
public static final int OFFSET_DATA_LENGTH_WORD_UNCOMPRESSED
```
  See Also:
  
  Constant Field Values
- OFFSET_DATA_LENGTH_WORD_COMPRESSED
```
public static final int OFFSET_DATA_LENGTH_WORD_COMPRESSED
```
  See Also:
  
  Constant Field Values
- OFFSET_NUMBER_OF_EVENTS
```
public static final int OFFSET_NUMBER_OF_EVENTS
```
  See Also:
  
  Constant Field Values
- OFFSET_HEADER_LENGTH_WORD
```
public static final int OFFSET_HEADER_LENGTH_WORD
```
  See Also:
  
  Constant Field Values
- OFFSET_INDEX_LENGTH_WORD
```
public static final int OFFSET_INDEX_LENGTH_WORD
```
  See Also:
  
  Constant Field Values

Constructor Detail

HipoRecordHeader
```
public HipoRecordHeader()
```

HipoRecordHeader
```
public HipoRecordHeader(byte[] array)
```

Method Detail

initBinary

public final void initBinary(byte[] array)

isValid
```
public final boolean isValid()
```

getDataSize
```
public int getDataSize()
```

getDataSizeCompressed
```
public int getDataSizeCompressed()
```

getRecordHeaderLength
```
public int getRecordHeaderLength()
```

getNumberOfEvents
```
public int getNumberOfEvents()
```

getRecordSize
```
public int getRecordSize()
```

getHeaderSize
```
public int getHeaderSize()
```

getIndexArraySize
```
public final int getIndexArraySize()
```

getCompressionType
```
public int getCompressionType()
```

getRecordHeaderData
```
public byte[] getRecordHeaderData()
```

getPositionInFile
```
public long getPositionInFile()
```

setPositionInFile

public void setPositionInFile(long pos)

setDataSize

public final void setDataSize(int size)

setDataSizeCompressed

public final void setDataSizeCompressed(int size)

setIndexArraySize

public final void setIndexArraySize(int size)

setRecordHeaderLength

public final void setRecordHeaderLength(int length)

setNumberOfEvents

public final void setNumberOfEvents(int nevents)

setHeaderSize

public final void setHeaderSize(int size)

setCompressionType

public void setCompressionType(int type)

setRecordSize
```
public void setRecordSize(int size)
```

toString
```
public java.lang.String toString()
```
Overrides:

toString in class java.lang.Object

reset
```
public final void reset()
```

main

public static void main(java.lang.String[] args)

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Class HipoRecordHeader

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

RECORD_HEADER_SIZE

RECORD_IDENTIFIER_STRING

RECORD_IDENTIFIER_INTEGER

OFFSET_RECORD_LENGTH_WORD

OFFSET_DATA_LENGTH_WORD_UNCOMPRESSED

OFFSET_DATA_LENGTH_WORD_COMPRESSED

OFFSET_NUMBER_OF_EVENTS

OFFSET_HEADER_LENGTH_WORD

OFFSET_INDEX_LENGTH_WORD

Constructor Detail

HipoRecordHeader

HipoRecordHeader

Method Detail

initBinary

isValid

getDataSize

getDataSizeCompressed

getRecordHeaderLength

getNumberOfEvents

getRecordSize

getHeaderSize

getIndexArraySize

getCompressionType

getRecordHeaderData

getPositionInFile

setPositionInFile

setDataSize

setDataSizeCompressed

setIndexArraySize

setRecordHeaderLength

setNumberOfEvents

setHeaderSize

setCompressionType

setRecordSize

toString

reset

main