Package org.yamcs.alarms
Enum AlarmState
- java.lang.Object
-
- java.lang.Enum<AlarmState>
-
- org.yamcs.alarms.AlarmState
-
- All Implemented Interfaces:
Serializable
,Comparable<AlarmState>
public enum AlarmState extends Enum<AlarmState>
Inspired from ANSI/ISA–18.2 Management Of Alarm Systems For The Process Industries process is the entity that triggers the alarm, in our case parameters or events.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ACK_ALARM
LATCH_ACK
LATCH_UNACK
NORMAL
RTN_UNACK
SHELVED
UNACK_ALARM
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method 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.
-
-
-
Enum Constant Detail
-
NORMAL
public static final AlarmState NORMAL
-
UNACK_ALARM
public static final AlarmState UNACK_ALARM
-
ACK_ALARM
public static final AlarmState ACK_ALARM
-
RTN_UNACK
public static final AlarmState RTN_UNACK
-
LATCH_UNACK
public static final AlarmState LATCH_UNACK
-
LATCH_ACK
public static final AlarmState LATCH_ACK
-
SHELVED
public static final AlarmState SHELVED
-
-
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 nameNullPointerException
- if the argument is null
-
-