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>

public enum CommandState
extends Enum<CommandState>

State elements that deal with 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 When an Agent is busy executing an Action type command it will be in ACTIVE state.
ALMOST_ACTIVE Upon receipt of an Action type command, the Agent will internally migrate to the ALMOST_ACTIVE state while it decides if the command is accepted or rejected.
READY The READY state is the initial state of an Agent and signifies that the Agent is ready to receive any commands (including actions).

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

Enum Constant Detail

READY

public static final CommandState READY

The READY state is the initial state of an Agent and signifies that the Agent is ready to receive any commands (including actions). Query commands will not change the CommandState. The CommandState is only changed by Action type commands.

ALMOST_ACTIVE

public static final CommandState ALMOST_ACTIVE

Upon receipt of an Action type command, the Agent will internally migrate to the ALMOST_ACTIVE state while it decides if the command is accepted or rejected. If the command is rejected, it will go back to the READY state. If the command is accepted, it will move into ACTIVE state. This state is never published.

ACTIVE

public static final CommandState ACTIVE

When an Agent is busy executing an Action type command it will be in ACTIVE state. Upon completion of the command execution the state will go back to READY.

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