org.lsst.ccs.bus.states

Enum PhaseState

java.lang.Object

java.lang.Enum<PhaseState>

org.lsst.ccs.bus.states.PhaseState

All Implemented Interfaces:

Serializable, Comparable<PhaseState>, AgentState

public enum PhaseState
extends Enum<PhaseState>
implements AgentState

The Phase State Diagram reflects the stages of an Agent's life cycle, from when it starts to when it shuts down. 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
CLOSING Anytime a shutdown command is received by the Agent, it will go into CLOSING state and proceed to shutdown any attached hardware component (if present).
INITIALIZING When an Agent starts up it goes immediately in INITIALIZING state.
OFF_LINE The OFF_LINE state is reached upon successful shutdown.
OPERATIONAL An Agent that has been successfully initialized will run in Phase OPERATIONAL.

Method Summary

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

INITIALIZING

public static final PhaseState INITIALIZING

When an Agent starts up it goes immediately in INITIALIZING state. At this point all the hardware is initialized. If there is any problem with the Agent's initialization, the Phase state will remain INITIALIZING and the Operational State will be ENGINEERING_FAILURE. If the initialization is successful the Phase state will become OPERATIONAL and the Operational State will be ENGINEERING_OK.

OPERATIONAL

public static final PhaseState OPERATIONAL

An Agent that has been successfully initialized will run in Phase OPERATIONAL. If the Operational state is ENGINEERING_OK, then all is working properly for the Agent. If, after a successful initialization, there is a problem with the hardware, the Phase state will remain OPERATIONAL and the Operational state will migrate to ENGINEERING_FAILURE.

CLOSING

public static final PhaseState CLOSING

Anytime a shutdown command is received by the Agent, it will go into CLOSING state and proceed to shutdown any attached hardware component (if present). If anything goes wrong during the shutdown process, the Phase state will remain CLOSING and the Agent will go into ENGINEERING_FAILURE. If all goes well, the Phase state will become OFF_LINE.

OFF_LINE

public static final PhaseState OFF_LINE

The OFF_LINE state is reached upon successful shutdown. This state is published right before the JVM is terminated.

Method Detail

values

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

Returns:

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

valueOf

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