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)

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, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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.