Package org.jlab.coda.emu.support.codaComponent

Enum Class CODAClass

java.lang.Object
java.lang.Enum<CODAClass>
org.jlab.coda.emu.support.codaComponent.CODAClass
All Implemented Interfaces:
Serializable, Comparable<CODAClass>, Constable
public enum CODAClass extends 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.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    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
    Description
    String
    description()
    Get the description of this transition.
    static CODAClass
    get(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(String name)
    Returns the enum constant of this class with the specified name.
    static CODAClass[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

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

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • 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 Details

    • values

      public static CODAClass[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static CODAClass valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • get

      public static CODAClass get(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 String description()
      Get the description of this transition.
      Returns:
      description string.
      See Also:

    • 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.