org.lsst.ccs.bus.states

Enum CommandState

java.lang.Object

java.lang.Enum<CommandState>

org.lsst.ccs.bus.states.CommandState

All Implemented Interfaces:

Serializable, Comparable<CommandState>, AgentState

public enum CommandState
extends Enum<CommandState>
implements AgentState

Agent State with respect to command execution. The Agent State Diagrams can be viewed at https://confluence.slac.stanford.edu/display/LSSTCAM/State+Diagrams.

Author:

The LSST CCS Team

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACTIVE The Agent is already executing ACTION or CONFIGURATION command, only QUERY and SIGNAL commands are accepted.
READY The Agent is ready to receive and execute all types of commands.

Method Summary

Modifier and Type	Method and Description
static CommandState	valueOf(String name) Returns the enum constant of this type with the specified name.
static CommandState[]	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

Methods inherited from interface org.lsst.ccs.bus.states.AgentState

isLegal, isLegal

Enum Constant Detail

READY

public static final CommandState READY

The Agent is ready to receive and execute all types of commands.

ACTIVE

public static final CommandState ACTIVE

The Agent is already executing ACTION or CONFIGURATION command, only QUERY and SIGNAL commands are accepted.

Method Detail

values

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

Returns:

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

valueOf

public static CommandState valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null