org.jlab.coda.emu.support.data

Enum EventType

java.lang.Object

java.lang.Enum<EventType>

org.jlab.coda.emu.support.data.EventType

All Implemented Interfaces:

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

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

This enum specifies values associated with CODA event types used in CODA online components.

Author:

timmer

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONTROL
DISENTANGLED_PHYSICS
OTHER
PARTIAL_PHYSICS
PHYSICS
ROC_RAW
USER

Method Summary

Modifier and Type	Method and Description
static EventType	getEventType(int val) Obtain the enum from the value.
static java.lang.String	getName(int val) Obtain the name from the value.
int	getValue() Get the integer value of this enum.
boolean	isAnyPhysics() Is this a any kind of a physics event type?
boolean	isBuildable() Is this a type buildable by the event builder?
boolean	isControl() Is this a control event type?
boolean	isDisentangledPhysics() Is this a fully-built, disentangled physics event type?
boolean	isEbFriendly() Is this a type appropriate for the event builder?
boolean	isPartialPhysics() Is this a partially-built physics event type? If so, this event did not yet make it through all the layers of event building.
boolean	isPhysics() Is this a fully-built, but entangled physics event type?
boolean	isROCRaw() Is this a data event type?
boolean	isUser() Is this a user event type?
boolean	isUserOrControl() Is this a usr or control event type?
static EventType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static EventType[]	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

ROC_RAW

public static final EventType ROC_RAW

PHYSICS

public static final EventType PHYSICS

PARTIAL_PHYSICS

public static final EventType PARTIAL_PHYSICS

DISENTANGLED_PHYSICS

public static final EventType DISENTANGLED_PHYSICS

USER

public static final EventType USER

CONTROL

public static final EventType CONTROL

OTHER

public static final EventType OTHER

Method Detail

values

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

Returns:

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

valueOf

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

getEventType

public static EventType getEventType(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.

isControl

public boolean isControl()

Is this a control event type?

Returns:

true if control event type, else false

isUserOrControl

public boolean isUserOrControl()

Is this a usr or control event type?

Returns:

true if user or control event type, else false

isROCRaw

public boolean isROCRaw()

Is this a data event type?

Returns:

true if data event type, else false

isAnyPhysics

public boolean isAnyPhysics()

Is this a any kind of a physics event type?

Returns:

true if any kind of a physics event type, else false

isPhysics

public boolean isPhysics()

Is this a fully-built, but entangled physics event type?

Returns:

true if complete, but entangled physics event type, else false

isPartialPhysics

public boolean isPartialPhysics()

Is this a partially-built physics event type? If so, this event did not yet make it through all the layers of event building.

Returns:

true if partially-built physics event type, else false

isDisentangledPhysics

public boolean isDisentangledPhysics()

Is this a fully-built, disentangled physics event type?

Returns:

true if complete and disentangled physics event type, else false

isEbFriendly

public boolean isEbFriendly()

Is this a type appropriate for the event builder?

Returns:

true if appropriate for the event builder, else false

isBuildable

public boolean isBuildable()

Is this a type buildable by the event builder?

Returns:

true if buildable by the event builder, else false

isUser

public boolean isUser()

Is this a user event type?

Returns:

true if user event type, else false