org.jlab.coda.emu.support.codaComponent

Enum CODAClass

java.lang.Object

java.lang.Enum<CODAClass>

org.jlab.coda.emu.support.codaComponent.CODAClass

All Implemented Interfaces:

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

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

This class is an enum which lists all the possible CODA class values, which are the types of CODA components such as ROC, EMU, or ER.

Author:

timmer

Enum Constant Summary

Enum Constants

Enum Constant and Description
DC Data concentrator (first level) type of event builder.
EBER Event builder and Event recorder connected with fifo - to be used with DC's or ROCs.
EMU Event management unit.
ER Event Recorder.
FCS Farm Controller.
GT GT
PEB Primary event builder (one and only one event builder).
PEBER Event builder and Event recorder connected with fifo - to be used with ROCs.
ROC Read out controller.
SEB Secondary (second level) type of event builder - to be used with DC's.
SEBER Event builder and Event recorder connected with fifo - to be used with DCs.
SLC Slow control component.
TS Trigger supervisor.
USR User component.

Method Summary

Modifier and Type	Method and Description
java.lang.String	description() Get the description of this transition.
static CODAClass	get(java.lang.String s) Map from type of incoming message from CODA class name to a particular enum.
int	getPriority() Get the default priority associated with this CODA class.
boolean	isEventBuilder() Is this class representative of an event building emu?
boolean	isEventRecorder() Is this class representative of an event recording emu?
boolean	isFinalEventBuilder() Is this class representative of a final event building emu (NOT DC)?
static CODAClass	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CODAClass[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TS

public static final CODAClass TS

Trigger supervisor.

GT

public static final CODAClass GT

GT

ROC

public static final CODAClass ROC

Read out controller.

DC

public static final CODAClass DC

Data concentrator (first level) type of event builder.

EBER

public static final CODAClass EBER

Event builder and Event recorder connected with fifo - to be used with DC's or ROCs.

PEBER

public static final CODAClass PEBER

Event builder and Event recorder connected with fifo - to be used with ROCs.

SEBER

public static final CODAClass SEBER

Event builder and Event recorder connected with fifo - to be used with DCs.

SEB

public static final CODAClass SEB

Secondary (second level) type of event builder - to be used with DC's.

PEB

public static final CODAClass PEB

Primary event builder (one and only one event builder).

FCS

public static final CODAClass FCS

Farm Controller.

ER

public static final CODAClass ER

Event Recorder.

SLC

public static final CODAClass SLC

Slow control component.

USR

public static final CODAClass USR

User component.

EMU

public static final CODAClass EMU

Event management unit.

Method Detail

values

public static CODAClass[] 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 (CODAClass c : CODAClass.values())
    System.out.println(c);

Returns:

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

valueOf

public static CODAClass 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

get

public static CODAClass get(java.lang.String s)

Map from type of incoming message from CODA class name to a particular enum.

Parameters:

s - CODA class name.

Returns:

associated enum, else null.

description

public java.lang.String description()

Get the description of this transition.

Returns:

description string.

See Also:

Command.description()

getPriority

public int getPriority()

Get the default priority associated with this CODA class.

Returns:

priority.

isEventBuilder

public boolean isEventBuilder()

Is this class representative of an event building emu?

Returns:

true if this class represents an event building emu, else false.

isFinalEventBuilder

public boolean isFinalEventBuilder()

Is this class representative of a final event building emu (NOT DC)?

Returns:

true if this class represents a final event building emu, else false.

isEventRecorder

public boolean isEventRecorder()

Is this class representative of an event recording emu?

Returns:

true if this class represents an event recording emu, else false.