org.lsst.ccs.bus.states

Enum OperationalState

java.lang.Object

java.lang.Enum<OperationalState>

org.lsst.ccs.bus.states.OperationalState

All Implemented Interfaces:

Serializable, Comparable<OperationalState>, AgentState

public enum OperationalState
extends Enum<OperationalState>
implements AgentState

The Operational State of an Agent. It relates to which commands it can accept and if there is any problem with the hardware. The Agent State Diagrams can be viewed at https://confluence.slac.stanford.edu/display/LSSTCAM/State+Diagrams

Author:

LSST CCS Team

Enum Constant Summary

Enum Constants

Enum Constant and Description
ENGINEERING_FAULT Commands can be accepted for any Component (provided a sufficient level).
ENGINEERING_OK Commands can be accepted for any Component (provided a sufficient level).
NORMAL Commands that are accepted are only top level Agent commands.

Method Summary

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

NORMAL

public static final OperationalState NORMAL

Commands that are accepted are only top level Agent commands. No commands can be sent to sub-modules.

ENGINEERING_OK

public static final OperationalState ENGINEERING_OK

Commands can be accepted for any Component (provided a sufficient level). When an Agent starts up it goes in ENGINEERING_OK if all was well during initialization.

ENGINEERING_FAULT

public static final OperationalState ENGINEERING_FAULT

Commands can be accepted for any Component (provided a sufficient level). When an Agent starts up it goes in ENGINEERING_FAULT if there was any problem during initialization. After initialization is complete an Agent will reach the ENGINEERING_FAILURE state if any problem occurs with the Agent (for example a hardware problem) Is this FAULT or FAILURE?

Method Detail

values

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

Returns:

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

valueOf

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