org.lsst.ccs.bus.states

Enum ConfigurationState

java.lang.Object

java.lang.Enum<ConfigurationState>

org.lsst.ccs.bus.states.ConfigurationState

All Implemented Interfaces:

Serializable, Comparable<ConfigurationState>, AgentState

public enum ConfigurationState
extends Enum<ConfigurationState>
implements AgentState

The Configuration state of a subsystem reflects the state of its set of configurable parameters. 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
CONFIGURED The current configuration state is fully backed up by the configuration system.
CONFIGURING The subsystem has been submitted one or more potential changes that have not been applied yet.
DIRTY The current configuration state has been modified and not saved yet.
UNCONFIGURED The configuration system is unreachable.

Method Summary

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

CONFIGURED

public static final ConfigurationState CONFIGURED

The current configuration state is fully backed up by the configuration system.

DIRTY

public static final ConfigurationState DIRTY

The current configuration state has been modified and not saved yet.

CONFIGURING

public static final ConfigurationState CONFIGURING

The subsystem has been submitted one or more potential changes that have not been applied yet.

UNCONFIGURED

public static final ConfigurationState UNCONFIGURED

The configuration system is unreachable.

Method Detail

values

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

Returns:

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

valueOf

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