org.jlab.coda.eventViewer

Class EvioScannerV6

java.lang.Object

org.jlab.coda.eventViewer.EvioScannerV6

public class EvioScannerV6
extends java.lang.Object

This class is used to scan an EVIO VERSION 6 file for block info, event info, and evio errors in order to catalog them for later viewing.

Author:

timmer (1/9/15)

Constructor Summary

Constructors

Constructor and Description
EvioScannerV6(FileFrameV6 component, MyTableModel dataModel, MyRenderer dataRenderer, FileFrameV6.ErrorScanTask errorTask) Constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	checkDataTypeAndPadding(int dataTypeVal, int pad) Check the given data type and padding to see if they're valid (or non-null) values and consistent with each other.
static boolean	dataTypeHasPadding(org.jlab.coda.jevio.DataType type) Is the given data type one that can have non-zero padding?
java.util.ArrayList<BlockHeaderV6>	getBlockErrorNodes() Get the list of BlockHeaderV6 objects containing evio errors.
boolean	hasError() Did the scan of the file show any evio errors?
boolean	scanFileForErrors() Scan the file for evio errors.

Methods inherited from class java.lang.Object

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

Constructor Detail

EvioScannerV6

public EvioScannerV6(FileFrameV6 component,
                     MyTableModel dataModel,
                     MyRenderer dataRenderer,
                     FileFrameV6.ErrorScanTask errorTask)
              throws org.jlab.coda.jevio.EvioException

Constructor.

Parameters:

component - window that displays a file's bytes as hex, 32 bit integers.

dataModel - data table model - object with file memory maps.

dataRenderer - data table render.

errorTask - object doing file scan in background, use to update its progress.

Throws:

org.jlab.coda.jevio.EvioException - if endianness is wrong, version is wrong, or too little data to read block header

Method Detail

dataTypeHasPadding

public static boolean dataTypeHasPadding(org.jlab.coda.jevio.DataType type)

Is the given data type one that can have non-zero padding?

Parameters:

type - evio data type

Returns:

true if the data type can have non-zero padding, else false.

getBlockErrorNodes

public java.util.ArrayList<BlockHeaderV6> getBlockErrorNodes()

Get the list of BlockHeaderV6 objects containing evio errors.

Returns:

list of BlockHeaderV6 objects containing evio errors.

hasError

public boolean hasError()

Did the scan of the file show any evio errors?

Returns:

true if there were errors, else false.

checkDataTypeAndPadding

public java.lang.String checkDataTypeAndPadding(int dataTypeVal,
                                                int pad)

Check the given data type and padding to see if they're valid (or non-null) values and consistent with each other.

Parameters:

dataTypeVal - data type as integer.

pad - padding of data.

Returns:

null if no error, else string describing error.

scanFileForErrors

public boolean scanFileForErrors()
                          throws org.jlab.coda.jevio.EvioException

Scan the file for evio errors.

Returns:

true if error occurred, else false

Throws:

org.jlab.coda.jevio.EvioException - if file cannot even be attempted to be parsed