org.jlab.coda.eventViewer

Class EvioHeader

java.lang.Object

org.jlab.coda.eventViewer.EvioHeader

All Implemented Interfaces:

java.lang.Cloneable

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

Abbreviated copy of the org.jlab.code.jevio.EvioNode class. Used to represent an evio structure such as a Bank, Segment, or Tagsegment.

Author:

timmer (1/20/17)

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.lang.String	bankType Type of bank based on tag's value.
(package private) long	dataLen Length of node's data in 32-bit words.
(package private) long	dataPos Position of node's data in file in bytes.
(package private) int	dataType Type of data stored in node.
(package private) java.lang.String	error Contains description of any error in event's header.
(package private) EvioHeader	errorHeader If this is an event, this contains the header in which an error has occurred if at a different evio level.
(package private) boolean	isEvent Does this node represent an event (top-level bank)?
(package private) long	len Header's length value (32-bit words).
(package private) MyTableModel	model Data source that this node is associated with.
(package private) int	num Num, only meaningful for Bank.
(package private) int	pad Padding, only meaningful if type is 8 or 16 bit int.
(package private) int	place Place of containing event in file/buffer.
(package private) long	pos Position of header in file in bytes.
(package private) int	tag Tag.
(package private) int	type This node's (evio container's) type.
(package private) java.lang.Long	wordIndex For some applications it's nice to know the word index this event starts at.

Constructor Summary

Constructors

Constructor and Description
EvioHeader(int word1, int word2) Constructor which creates an EvioNode associated with an event (top level).
EvioHeader(int word1, int word2, java.lang.Long wordIndex) Constructor which creates an EvioNode associated with an event (top level) and specifies its first word's file position.
EvioHeader(long pos, int place, MyTableModel model) Constructor which creates an EvioNode associated with an event (top level) evio container when parsing buffers for evio data.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone()
org.jlab.coda.jevio.DataType	getDataTypeObj() Get the evio type of the data this evio structure contains as an object.
long	getFilePosition() Get the position of this event in file.
org.jlab.coda.jevio.DataType	getTypeObj() Get the evio type of this evio structure as an object.
boolean	probablyIsBank() When scanning for events, the user initially clicks on a first header word value.
void	setAll(int word1, int word2, long pos, long dataPos, int dataLen, boolean isEvent) Set all relevant parameters.

Methods inherited from class java.lang.Object

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

Field Detail

len

long len

Header's length value (32-bit words).

pos

long pos

Position of header in file in bytes.

type

int type

This node's (evio container's) type. Must be bank, segment, or tag segment.

tag

int tag

Tag.

num

int num

Num, only meaningful for Bank.

pad

int pad

Padding, only meaningful if type is 8 or 16 bit int.

dataLen

long dataLen

Length of node's data in 32-bit words.

dataPos

long dataPos

Position of node's data in file in bytes.

dataType

int dataType

Type of data stored in node.

bankType

java.lang.String bankType

Type of bank based on tag's value.

error

java.lang.String error

Contains description of any error in event's header.

isEvent

boolean isEvent

Does this node represent an event (top-level bank)?

model

MyTableModel model

Data source that this node is associated with.

wordIndex

java.lang.Long wordIndex

For some applications it's nice to know the word index this event starts at.

place

int place

Place of containing event in file/buffer. First event = 0, second = 1, etc.

errorHeader

EvioHeader errorHeader

If this is an event, this contains the header in which an error has occurred if at a different evio level.

Constructor Detail

EvioHeader

EvioHeader(int word1,
           int word2)

Constructor which creates an EvioNode associated with an event (top level).

Parameters:

word1 - event's first header word

word2 - event's second header word

EvioHeader

EvioHeader(int word1,
           int word2,
           java.lang.Long wordIndex)

Constructor which creates an EvioNode associated with an event (top level) and specifies its first word's file position.

Parameters:

word1 - event's first header word

word2 - event's second header word

wordIndex - index of word in file at which this event starts

EvioHeader

EvioHeader(long pos,
           int place,
           MyTableModel model)

Constructor which creates an EvioNode associated with an event (top level) evio container when parsing buffers for evio data.

Parameters:

pos - position of event in buffer (number of bytes)

place - containing event's place in buffer (starting at 1)

model - data source containing this event

Method Detail

probablyIsBank

public boolean probablyIsBank()

When scanning for events, the user initially clicks on a first header word value. It may or may not be the first word of an evio bank. This method tells whether this object, created from those 2 words, is most likely a bank or is not.

Returns:

true if it is most likely a bank, else false.

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

setAll

public void setAll(int word1,
                   int word2,
                   long pos,
                   long dataPos,
                   int dataLen,
                   boolean isEvent)

Set all relevant parameters.

Parameters:

word1 - event's first header word

word2 - event's second header word

pos - evio structure's byte position in file

dataPos - evio structure's data position in file

dataLen - length of node data in 32-bit words

isEvent - is this structure an event (top-level bank)?

getFilePosition

public long getFilePosition()

Get the position of this event in file.

Returns:

position of this event in file.

getDataTypeObj

public org.jlab.coda.jevio.DataType getDataTypeObj()

Get the evio type of the data this evio structure contains as an object.

Returns:

evio type of the data this evio structure contains as an object.

getTypeObj

public org.jlab.coda.jevio.DataType getTypeObj()

Get the evio type of this evio structure as an object.

Returns:

evio type of this evio structure as an object.