org.jlab.coda.eventViewer

Class BlockHeaderV6

java.lang.Object

org.jlab.coda.eventViewer.BlockHeaderV6

All Implemented Interfaces:

java.lang.Cloneable

public final class BlockHeaderV6
extends java.lang.Object
implements java.lang.Cloneable

Modified copy of the org.jlab.code.jevio.BlockNode class but for evio version 6 records.

Author:

timmer (3/25/21)

Field Summary

Fields

Modifier and Type	Field and Description
(package private) int	compressedDataWords Data length of compressed, following data in words.
(package private) int	compressionType Type of data compression, 0 = none, 1 = lz4 , 2 = lz4_best, 3 = gzip.
(package private) java.lang.String	compressionTypeStr
(package private) int	count Number of events in record.
(package private) int	currentEventIndex The index into the "events" list of the element that is currently being looked at (starting at 0).
(package private) java.lang.String	error Contains description of any error in record's data.
(package private) java.util.ArrayList<EvioHeader>	events If error somewhere in this record, store reference to each contained event.
(package private) long	filePos Position of record in file.
(package private) boolean	hasDictionary Record has dictionary event.
(package private) int	headerLen Record's header length value (32-bit words).
(package private) int	indexArrayBytes Index array length in bytes.
(package private) int	infoWord Word containing version, hasDictionary, and is Last info.
(package private) boolean	isLast Is last record in file.
(package private) long	len Record's length value (32-bit words), inclusive.
(package private) static int	MAGIC_INT
(package private) int	place Place of this record in file/buffer or record number.
(package private) long	register1 User defined long register 1.
(package private) long	register2 User defined long register 2.
(package private) int	totalBytes Total bytes of header + index + user header.
(package private) int	uncompressedDataBytes Following data, uncompressed, in bytes.
(package private) int	userHeaderBytes Length of user defined data in bytes.
(package private) int	version Evio version.

Constructor Summary

Constructors

Constructor and Description
BlockHeaderV6()

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone()
(package private) void	setData(java.nio.ByteBuffer recordInts) Set members given an array containing the record header values.
(package private) void	setData(int[] recordInts, java.nio.ByteOrder order) Set members given an array containing the record header values.
(package private) void	setInfoWord(int infoWord) Given the info word, set version, isLast, and hasDictionary values.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

MAGIC_INT

static int MAGIC_INT

len

long len

Record's length value (32-bit words), inclusive.

headerLen

int headerLen

Record's header length value (32-bit words).

count

int count

Number of events in record.

filePos

long filePos

Position of record in file.

place

int place

Place of this record in file/buffer or record number. First record = 1, second = 2, etc.

infoWord

int infoWord

Word containing version, hasDictionary, and is Last info.

version

int version

Evio version.

hasDictionary

boolean hasDictionary

Record has dictionary event.

isLast

boolean isLast

Is last record in file.

indexArrayBytes

int indexArrayBytes

Index array length in bytes. Index array contains lengths of each event in bytes.

userHeaderBytes

int userHeaderBytes

Length of user defined data in bytes.

uncompressedDataBytes

int uncompressedDataBytes

Following data, uncompressed, in bytes.

compressionType

int compressionType

Type of data compression, 0 = none, 1 = lz4 , 2 = lz4_best, 3 = gzip.

compressionTypeStr

java.lang.String compressionTypeStr

compressedDataWords

int compressedDataWords

Data length of compressed, following data in words.

register1

long register1

User defined long register 1.

register2

long register2

User defined long register 2.

totalBytes

int totalBytes

Total bytes of header + index + user header.

error

java.lang.String error

Contains description of any error in record's data.

currentEventIndex

int currentEventIndex

The index into the "events" list of the element that is currently being looked at (starting at 0).

events

final java.util.ArrayList<EvioHeader> events

If error somewhere in this record, store reference to each contained event.

Constructor Detail

BlockHeaderV6

public BlockHeaderV6()

Method Detail

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

setInfoWord

void setInfoWord(int infoWord)

Given the info word, set version, isLast, and hasDictionary values.

Parameters:

infoWord - info word of record header

setData

void setData(int[] recordInts,
             java.nio.ByteOrder order)

Set members given an array containing the record header values.

Parameters:

recordInts - array containing the record header values in proper order.

order - byte order of data in recordInts so longs can be parsed properly.

setData

void setData(java.nio.ByteBuffer recordInts)

Set members given an array containing the record header values.

Parameters:

recordInts - array containing the record header values in proper order.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object