org.jlab.coda.eventViewer

Enum CodaBankTag

java.lang.Object

java.lang.Enum<CodaBankTag>

org.jlab.coda.eventViewer.CodaBankTag

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CodaBankTag>

public enum CodaBankTag
extends java.lang.Enum<CodaBankTag>

This an enum listing the evio tag values reserved for and used by the CODA group for online designations. Used to convert numerical tag values to a meaningful name. For example, the tag with value 0xff10 corresponds to the enum TRIGGER_RAW_NOTS which refers to a raw trigger bank with no timestamps.

Author:

timmer

Enum Constant Summary

Enum Constants

Enum Constant and Description
END End event
GO Go event
PAUSE Pause event
PEB Primary event builder
PEB_SYNC Primary event builder with sync set
PRESTART Prestart event
SEB Secondary event builder
SEB_SYNC Secondary event builder with sync set
SYNC Sync event
TRIGGER_BUILT_NOTS_NORUN Built trigger bank, no timestamps, run: no #/type, with specific
TRIGGER_BUILT_NOTS_NORUN_NOSPEC Built trigger bank, no timestamps, run: no #, type or specific
TRIGGER_BUILT_NOTS_RUN Built trigger bank, no timestamps, run: with #, type and specific
TRIGGER_BUILT_NOTS_RUN_NOSPEC Built trigger bank, no timestamps, run: #/type, no specific
TRIGGER_BUILT_TS_NORUN Built trigger bank, with timestamps, run: no #/type, with specific
TRIGGER_BUILT_TS_NORUN_NOSPEC Built trigger bank, with timestamps, run: no #, type or specific
TRIGGER_BUILT_TS_RUN Built trigger bank, with timestamps, run: with #, type and specific
TRIGGER_BUILT_TS_RUN_NOSPEC Built trigger bank, with timestamps, run: no #/type, no specific
TRIGGER_RAW_NOTS Raw trigger bank, no timestamps
TRIGGER_RAW_TS Raw trigger bank, with timestamps

Method Summary

Modifier and Type	Method and Description
static CodaBankTag	getBankType(int val) Obtain the enum from the tag value or null if none.
java.lang.String	getDescription() Get the enum's description.
static java.lang.String	getDescription(int val) Obtain the description from the tag value.
static java.lang.String	getName(int val) Obtain the name from the tag value.
int	getValue() Get the enum's tag value.
static CodaBankTag	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CodaBankTag[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TRIGGER_RAW_NOTS

public static final CodaBankTag TRIGGER_RAW_NOTS

Raw trigger bank, no timestamps

TRIGGER_RAW_TS

public static final CodaBankTag TRIGGER_RAW_TS

Raw trigger bank, with timestamps

TRIGGER_BUILT_NOTS_NORUN

public static final CodaBankTag TRIGGER_BUILT_NOTS_NORUN

Built trigger bank, no timestamps, run: no #/type, with specific

TRIGGER_BUILT_TS_NORUN

public static final CodaBankTag TRIGGER_BUILT_TS_NORUN

Built trigger bank, with timestamps, run: no #/type, with specific

TRIGGER_BUILT_NOTS_RUN

public static final CodaBankTag TRIGGER_BUILT_NOTS_RUN

Built trigger bank, no timestamps, run: with #, type and specific

TRIGGER_BUILT_TS_RUN

public static final CodaBankTag TRIGGER_BUILT_TS_RUN

Built trigger bank, with timestamps, run: with #, type and specific

TRIGGER_BUILT_NOTS_NORUN_NOSPEC

public static final CodaBankTag TRIGGER_BUILT_NOTS_NORUN_NOSPEC

Built trigger bank, no timestamps, run: no #, type or specific

TRIGGER_BUILT_TS_NORUN_NOSPEC

public static final CodaBankTag TRIGGER_BUILT_TS_NORUN_NOSPEC

Built trigger bank, with timestamps, run: no #, type or specific

TRIGGER_BUILT_NOTS_RUN_NOSPEC

public static final CodaBankTag TRIGGER_BUILT_NOTS_RUN_NOSPEC

Built trigger bank, no timestamps, run: #/type, no specific

TRIGGER_BUILT_TS_RUN_NOSPEC

public static final CodaBankTag TRIGGER_BUILT_TS_RUN_NOSPEC

Built trigger bank, with timestamps, run: no #/type, no specific

PEB

public static final CodaBankTag PEB

Primary event builder

PEB_SYNC

public static final CodaBankTag PEB_SYNC

Primary event builder with sync set

SEB

public static final CodaBankTag SEB

Secondary event builder

SEB_SYNC

public static final CodaBankTag SEB_SYNC

Secondary event builder with sync set

SYNC

public static final CodaBankTag SYNC

Sync event

PRESTART

public static final CodaBankTag PRESTART

Prestart event

GO

public static final CodaBankTag GO

Go event

PAUSE

public static final CodaBankTag PAUSE

Pause event

END

public static final CodaBankTag END

End event

Method Detail

values

public static CodaBankTag[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CodaBankTag c : CodaBankTag.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CodaBankTag valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getBankType

public static CodaBankTag getBankType(int val)

Obtain the enum from the tag value or null if none.

Parameters:

val - the tag value to match.

Returns:

the matching enum, or null.

getName

public static java.lang.String getName(int val)

Obtain the name from the tag value.

Parameters:

val - the tag value to match.

Returns:

the name, or "Unknown".

getDescription

public static java.lang.String getDescription(int val)

Obtain the description from the tag value.

Parameters:

val - the tag value to match.

Returns:

the description, or "Unknown".

getValue

public int getValue()

Get the enum's tag value.

Returns:

tag value

getDescription

public java.lang.String getDescription()

Get the enum's description.

Returns:

description