org.lsst.ccs.bus.states

Enum AlarmState

java.lang.Object

java.lang.Enum<AlarmState>

org.lsst.ccs.bus.states.AlarmState

All Implemented Interfaces:

Serializable, Comparable<AlarmState>

public enum AlarmState
extends Enum<AlarmState>

The Alarm State of an Agent reflects how the hardware measured quantities compare to their operational limits. The Alarm State is, at any point, the level of the highest active existing alarm. 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
ALARM The Alarm state goes into ALARM when there is at least one active alarm.
NOMINAL An Agent is in the NOMINAL state when all is well with the connected hardware.
WARNING The Alarm state is WARNING when there is at least one active warning, but no alarm level ones.

Method Summary

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

NOMINAL

public static final AlarmState NOMINAL

An Agent is in the NOMINAL state when all is well with the connected hardware.

WARNING

public static final AlarmState WARNING

The Alarm state is WARNING when there is at least one active warning, but no alarm level ones.

ALARM

public static final AlarmState ALARM

The Alarm state goes into ALARM when there is at least one active alarm.

Method Detail

values

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

Returns:

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

valueOf

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