org.lsst.ccs.bus.states

Enum AlertState

java.lang.Object

java.lang.Enum<AlertState>

org.lsst.ccs.bus.states.AlertState

All Implemented Interfaces:

Serializable, Comparable<AlertState>, AgentState

public enum AlertState
extends Enum<AlertState>
implements AgentState

The Alert State of an Agent reflects how the hardware measured quantities compare to their operational limits. The Alert State is, at any point, the level of the highest active existing alarm. It is also used to represent the severity of an Alert. It can be either WARNING or ALARM, depending on the condition in which the Alert is raised. When an Alert is raised the severity determines the change in the agent AlertState. The agent AlertState will match the highest severity level and lock onto it until all Alerts at that level have been cleared. 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 AlertState signifies that a given quantity has reached the alarm level.
NOMINAL The NOMINAL AlertState signifies that a given quantity has gone back within acceptable limits.
WARNING The WARNING AlertState signifies that a given quantity has reached the warning level.

Method Summary

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

NOMINAL

public static final AlertState NOMINAL

The NOMINAL AlertState signifies that a given quantity has gone back within acceptable limits. Alerts are not raised when the AlertState is NOMINAL. There is no effect on the AlertState of the agent.

WARNING

public static final AlertState WARNING

The WARNING AlertState signifies that a given quantity has reached the warning level. The corresponding Alert is raised and the AlertState of the Agent will switch to WARNING if it was previously NOMINAL, otherwise the AlertState of the agent will remain unchanged.

ALARM

public static final AlertState ALARM

The ALARM AlertState signifies that a given quantity has reached the alarm level. The corresponding Alert is raised and the AlertState of the agent will switch to ALARM if it was previously either NOMINAL or WARNING, otherwise the AlertState of the agent will remain unchanged.

Method Detail

values

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

Returns:

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

valueOf

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