CODATag

java.lang.Object
- java.lang.Enum<CODATag>
- - org.jlab.coda.emu.support.data.CODATag

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CODATag>
```
public enum CODATag
extends java.lang.Enum<CODATag>
```
This enum specifies values associated with tags used in CODA online components.

Author:

timmer

Enum Constant Summary

Enum Constants
Enum Constant and Description
`BUILT_BY_PEB` Event built by primary event builder.
`BUILT_BY_PEB_SYNC` Event built by primary event builder with sync bit set.
`BUILT_BY_SEB` Event built by secondary event builder.
`BUILT_BY_SEB_SYNC` Event built by secondary event builder with sync bit set.
`BUILT_TRIGGER_BANK` No timestamp and no run data.
`BUILT_TRIGGER_NRSD` No timestamp, no run and no roc-specific data.
`BUILT_TRIGGER_ROC_ERROR` At least one ROC used in building this trigger bank has a bad or nonexistent trigger bank of its own.
`BUILT_TRIGGER_RUN` Only run data.
`BUILT_TRIGGER_RUN_NRSD` Run and no roc-specific data.
`BUILT_TRIGGER_TS` Only timestamp data.
`BUILT_TRIGGER_TS_NRSD` Timestamp and no roc-specific data.
`BUILT_TRIGGER_TS_RUN` Both timestamp and run data.
`BUILT_TRIGGER_TS_RUN_NRSD` Timestamp and run, but no roc-specific data.
`RAW_TRIGGER` Trigger bank from ROC with no timestamps.
`RAW_TRIGGER_TS` Trigger bank from ROC with 32 bit timestamps.
`RAW_TRIGGER_TS_BIG` Trigger bank from ROC with 64 bit timestamps.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static java.lang.String`	`getName(int val)` Obtain the name from the value.
`static CODATag`	`getTagType(int val)` Obtain the enum from the value.
`int`	`getValue()` Get the integer value of this enum.
`boolean`	`hasRocSpecificData()` Does this tag indicate the trigger bank has roc-specific data segments present?
`static boolean`	`hasRocSpecificData(int value)` Does this tag indicate the trigger bank has roc-specific data segments present?
`boolean`	`hasRunData()` Does this tag indicate run number and type are present?
`static boolean`	`hasRunData(int value)` Does this tag indicate run number and type are present?
`boolean`	`hasTimestamp()` Does this tag indicate a timestamp is present?
`static boolean`	`hasTimestamp(int value)` Does this tag indicate a timestamp is present?
`boolean`	`isBuiltTrigger()` Is this a built trigger tag? Values can range from 0xff20 to 0xff4f.
`static boolean`	`isBuiltTrigger(int value)` Is this a built trigger tag? Values can range from 0xff20 to 0xff4f.
`boolean`	`isRawTrigger()` Is this a raw trigger tag? Values can range from 0xff10 to 0xff1f.
`static boolean`	`isRawTrigger(int value)` Is this a raw trigger tag? Values can range from 0xff10 to 0xff1f.
`boolean`	`isSyncEVent()` Is this any kind of a sync event tag?
`static boolean`	`isSyncEVent(int value)` Is this any kind of a sync event tag?
`boolean`	`isTrigger()` Is this any kind of a trigger tag? Values can range from 0xff10 to 0xff4f.
`static boolean`	`isTrigger(int value)` Is this any kind of a trigger tag? Values can range from 0xff10 to 0xff4f.
`static CODATag`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static CODATag[]`	`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
  - RAW_TRIGGER
```
public static final CODATag RAW_TRIGGER
```
    Trigger bank from ROC with no timestamps.
  - RAW_TRIGGER_TS
```
public static final CODATag RAW_TRIGGER_TS
```
    Trigger bank from ROC with 32 bit timestamps.
  - RAW_TRIGGER_TS_BIG
```
public static final CODATag RAW_TRIGGER_TS_BIG
```
    Trigger bank from ROC with 64 bit timestamps.
  - BUILT_TRIGGER_BANK
```
public static final CODATag BUILT_TRIGGER_BANK
```
    No timestamp and no run data.
  - BUILT_TRIGGER_TS
```
public static final CODATag BUILT_TRIGGER_TS
```
    Only timestamp data.
  - BUILT_TRIGGER_RUN
```
public static final CODATag BUILT_TRIGGER_RUN
```
    Only run data.
  - BUILT_TRIGGER_TS_RUN
```
public static final CODATag BUILT_TRIGGER_TS_RUN
```
    Both timestamp and run data.
  - BUILT_TRIGGER_NRSD
```
public static final CODATag BUILT_TRIGGER_NRSD
```
    No timestamp, no run and no roc-specific data.
  - BUILT_TRIGGER_TS_NRSD
```
public static final CODATag BUILT_TRIGGER_TS_NRSD
```
    Timestamp and no roc-specific data.
  - BUILT_TRIGGER_RUN_NRSD
```
public static final CODATag BUILT_TRIGGER_RUN_NRSD
```
    Run and no roc-specific data.
  - BUILT_TRIGGER_TS_RUN_NRSD
```
public static final CODATag BUILT_TRIGGER_TS_RUN_NRSD
```
    Timestamp and run, but no roc-specific data.
  - BUILT_TRIGGER_ROC_ERROR
```
public static final CODATag BUILT_TRIGGER_ROC_ERROR
```
    At least one ROC used in building this trigger bank has a bad or nonexistent trigger bank of its own.
  - BUILT_BY_PEB
```
public static final CODATag BUILT_BY_PEB
```
    Event built by primary event builder.
  - BUILT_BY_PEB_SYNC
```
public static final CODATag BUILT_BY_PEB_SYNC
```
    Event built by primary event builder with sync bit set.
  - BUILT_BY_SEB
```
public static final CODATag BUILT_BY_SEB
```
    Event built by secondary event builder.
  - BUILT_BY_SEB_SYNC
```
public static final CODATag BUILT_BY_SEB_SYNC
```
    Event built by secondary event builder with sync bit set.
- Method Detail
  - values
```
public static CODATag[] 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 (CODATag c : CODATag.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static CODATag 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
  - getTagType
```
public static CODATag getTagType(int val)
```
    Obtain the enum from the value.
    
    Parameters:
    
    val - the value to match.
    
    Returns:
    
    the matching enum, or null.
  - getName
```
public static java.lang.String getName(int val)
```
    Obtain the name from the value.
    
    Parameters:
    
    val - the value to match.
    
    Returns:
    
    the name, or null.
  - getValue
```
public int getValue()
```
    Get the integer value of this enum.
    
    Returns:
    
    the integer value of this enum.
  - isBuiltTrigger
```
public boolean isBuiltTrigger()
```
    Is this a built trigger tag? Values can range from 0xff20 to 0xff4f. Currently only 0xff20 to 0xff27 are used.
    
    Returns:
    
    true if built trigger tag, else false
  - isBuiltTrigger
```
public static boolean isBuiltTrigger(int value)
```
    Is this a built trigger tag? Values can range from 0xff20 to 0xff4f. Currently only 0xff20 to 0xff27 are used.
    
    Parameters:
    
    value - the tag value to check
    
    Returns:
    
    true if built trigger tag, else false
  - isRawTrigger
```
public boolean isRawTrigger()
```
    Is this a raw trigger tag? Values can range from 0xff10 to 0xff1f. Currently only 0xff10 to 0xff12 are used.
    
    Returns:
    
    true if raw trigger tag, else false
  - isRawTrigger
```
public static boolean isRawTrigger(int value)
```
    Is this a raw trigger tag? Values can range from 0xff10 to 0xff1f. Currently only 0xff10 to 0xff12 are used.
    
    Parameters:
    
    value - the tag value to check
    
    Returns:
    
    true if raw trigger tag, else false
  - isTrigger
```
public static boolean isTrigger(int value)
```
    Is this any kind of a trigger tag? Values can range from 0xff10 to 0xff4f. Currently only 0xff10 to 0xff27 are used.
    
    Parameters:
    
    value - the tag value to check
    
    Returns:
    
    true if any kind of trigger tag, else false
  - isTrigger
```
public boolean isTrigger()
```
    Is this any kind of a trigger tag? Values can range from 0xff10 to 0xff4f. Currently only 0xff10 to 0xff27 are used.
    
    Returns:
    
    true if any kind of trigger tag, else false
  - hasTimestamp
```
public boolean hasTimestamp()
```
    Does this tag indicate a timestamp is present?
    
    Returns:
    
    true if this tag indicates a timestamp exists, else false
  - hasTimestamp
```
public static boolean hasTimestamp(int value)
```
    Does this tag indicate a timestamp is present?
    
    Parameters:
    
    value - the tag value to check
    
    Returns:
    
    true if this tag indicates a timestamp exists, else false
  - hasRunData
```
public boolean hasRunData()
```
    Does this tag indicate run number and type are present?
    
    Returns:
    
    true if this tag indicates run number and type exist, else false
  - hasRunData
```
public static boolean hasRunData(int value)
```
    Does this tag indicate run number and type are present?
    
    Parameters:
    
    value - the tag value to check
    
    Returns:
    
    true if this tag indicates run number and type exist, else false
  - hasRocSpecificData
```
public boolean hasRocSpecificData()
```
    Does this tag indicate the trigger bank has roc-specific data segments present?
    
    Returns:
    
    true if this tag indicates trigger bank has roc-specific data segments present, else false
  - hasRocSpecificData
```
public static boolean hasRocSpecificData(int value)
```
    Does this tag indicate the trigger bank has roc-specific data segments present?
    
    Parameters:
    
    value - the tag value to check
    
    Returns:
    
    true if this tag indicates trigger bank has roc-specific data segments present, else false
  - isSyncEVent
```
public static boolean isSyncEVent(int value)
```
    Is this any kind of a sync event tag?
    
    Parameters:
    
    value - the tag value to check
    
    Returns:
    
    true if any kind of sync event tag, else false
  - isSyncEVent
```
public boolean isSyncEVent()
```
    Is this any kind of a sync event tag?
    
    Returns:
    
    true if any kind of sync event tag, else false

Enum CODATag

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

RAW_TRIGGER

RAW_TRIGGER_TS

RAW_TRIGGER_TS_BIG

BUILT_TRIGGER_BANK

BUILT_TRIGGER_TS

BUILT_TRIGGER_RUN

BUILT_TRIGGER_TS_RUN

BUILT_TRIGGER_NRSD

BUILT_TRIGGER_TS_NRSD

BUILT_TRIGGER_RUN_NRSD

BUILT_TRIGGER_TS_RUN_NRSD

BUILT_TRIGGER_ROC_ERROR

BUILT_BY_PEB

BUILT_BY_PEB_SYNC

BUILT_BY_SEB

BUILT_BY_SEB_SYNC

Method Detail

values

valueOf

getTagType

getName

getValue

isBuiltTrigger

isBuiltTrigger

isRawTrigger

isRawTrigger

isTrigger

isTrigger

hasTimestamp

hasTimestamp

hasRunData

hasRunData

hasRocSpecificData

hasRocSpecificData

isSyncEVent

isSyncEVent