org.jlab.coda.emu.support.codaComponent

Enum CODACommand

java.lang.Object

java.lang.Enum<CODACommand>

org.jlab.coda.emu.support.codaComponent.CODACommand

All Implemented Interfaces:

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

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

This class enumerates all the commands that Run Control can send to this Emu. These objects only contain static data.

Author:

timmer Date: 3/14/11

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CODACommand.InputType Ways in which a command's input obtained from a cMsg message.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONFIGURE Configure transition.
DISABLE_OUTPUT Command to disable output channels.
DOWNLOAD Download transition.
ENABLE_OUTPUT Command to enable output channels.
END End transition.
EXIT Command to exit.
GET_BUF_LEVEL Command to get buffer level - smallest evio-event/et-buffer for ROCs.
GET_CODA_CLASS Command to get the coda class.
GET_CONFIG_ID Command to get config id.
GET_OBJECT_TYPE Command to get the object type.
GET_RUN_NUMBER Command to get run number .
GET_RUN_TYPE Command to get run type.
GET_SESSION Command to get session.
GET_STATE Command to get the state .
GET_STATUS Command to get the status.
GO Go transition.
PRESTART Prestart transition.
RESET Reset transition.
SET_BUF_LEVEL Command to set buffer level - smallest evio-event/et-buffer for ROCs.
SET_INTERVAL Command to set time interval between reporting messages in seconds.
SET_PRE_END Command to tell emu, END button was pushed.
SET_RUN_NUMBER Command to set run number .
SET_RUN_TYPE Command to set run type.
SET_SESSION Command to set session.
START_REPORTING Command to set start reporting.
STOP_REPORTING Command to set stop reporting.

Method Summary

Modifier and Type	Method and Description
static CODACommand	get(java.lang.String s) Map from type of incoming message from run control to a particular enum.
java.lang.String	getCmdString() Get the string coming from Run Control specifying this command.
java.lang.String	getDescription() Get this command's description.
int	getGuiGroup()
static java.util.EnumSet<CODACommand>	getGuiGroup(int group) This method returns an EnumSet object of all the CODACommands which are of the given gui group.
CODACommand.InputType	getInputType()
java.lang.String	getPayloadName()
boolean	isTransition()
static CODACommand	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CODACommand[]	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

CONFIGURE

public static final CODACommand CONFIGURE

Configure transition.

DOWNLOAD

public static final CODACommand DOWNLOAD

Download transition.

PRESTART

public static final CODACommand PRESTART

Prestart transition.

GO

public static final CODACommand GO

Go transition.

END

public static final CODACommand END

End transition.

RESET

public static final CODACommand RESET

Reset transition.

GET_STATE

public static final CODACommand GET_STATE

Command to get the state .

GET_STATUS

public static final CODACommand GET_STATUS

Command to get the status.

GET_OBJECT_TYPE

public static final CODACommand GET_OBJECT_TYPE

Command to get the object type.

GET_CODA_CLASS

public static final CODACommand GET_CODA_CLASS

Command to get the coda class.

SET_BUF_LEVEL

public static final CODACommand SET_BUF_LEVEL

Command to set buffer level - smallest evio-event/et-buffer for ROCs.

GET_BUF_LEVEL

public static final CODACommand GET_BUF_LEVEL

Command to get buffer level - smallest evio-event/et-buffer for ROCs.

ENABLE_OUTPUT

public static final CODACommand ENABLE_OUTPUT

Command to enable output channels.

DISABLE_OUTPUT

public static final CODACommand DISABLE_OUTPUT

Command to disable output channels.

SET_INTERVAL

public static final CODACommand SET_INTERVAL

Command to set time interval between reporting messages in seconds.

START_REPORTING

public static final CODACommand START_REPORTING

Command to set start reporting.

STOP_REPORTING

public static final CODACommand STOP_REPORTING

Command to set stop reporting.

EXIT

public static final CODACommand EXIT

Command to exit.

SET_SESSION

public static final CODACommand SET_SESSION

Command to set session.

GET_SESSION

public static final CODACommand GET_SESSION

Command to get session.

SET_RUN_NUMBER

public static final CODACommand SET_RUN_NUMBER

Command to set run number .

GET_RUN_NUMBER

public static final CODACommand GET_RUN_NUMBER

Command to get run number .

SET_RUN_TYPE

public static final CODACommand SET_RUN_TYPE

Command to set run type.

GET_RUN_TYPE

public static final CODACommand GET_RUN_TYPE

Command to get run type.

GET_CONFIG_ID

public static final CODACommand GET_CONFIG_ID

Command to get config id.

SET_PRE_END

public static final CODACommand SET_PRE_END

Command to tell emu, END button was pushed.

Method Detail

values

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

Returns:

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

valueOf

public static CODACommand 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 CODACommand get(java.lang.String s)

Map from type of incoming message from run control to a particular enum.

Parameters:

s - type contained in incoming message from run control.

Returns:

associated enum, else null.

getInputType

public CODACommand.InputType getInputType()

getGuiGroup

public int getGuiGroup()

isTransition

public boolean isTransition()

getPayloadName

public java.lang.String getPayloadName()

getGuiGroup

public static java.util.EnumSet<CODACommand> getGuiGroup(int group)

This method returns an EnumSet object of all the CODACommands which are of the given gui group. This is used to automatically create the DebugGUI.

Parameters:

group - gui group we want the members of

Returns:

EnumSet of CODACommands which are member of the given gui group.

getCmdString

public java.lang.String getCmdString()

Get the string coming from Run Control specifying this command.

Returns:

string coming from Run Control specifying this command.

getDescription

public java.lang.String getDescription()

Get this command's description.

Returns:

this command's description.