Enum AlarmStateTransition
- java.lang.Object
-
- java.lang.Enum<AlarmStateTransition>
-
- com.inductiveautomation.ignition.common.alarming.AlarmStateTransition
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<AlarmStateTransition>
public enum AlarmStateTransition extends java.lang.Enum<AlarmStateTransition>
This enum represents a single alarm state, generally the state that a particular event represents the transition to. Put differently, an alarm can be in multiple states at once, such as Active|Ack. This enum represents a single element of that.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static AlarmStateTransition
fromIntValue(int value)
int
getIntValue()
static AlarmStateTransition
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static AlarmStateTransition[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
Active
public static final AlarmStateTransition Active
-
Clear
public static final AlarmStateTransition Clear
-
Ack
public static final AlarmStateTransition Ack
-
Finished
public static final AlarmStateTransition Finished
This transition is used to indicate that an alarm event is no longer needed and should drop out of the system.
-
-
Method Detail
-
values
public static AlarmStateTransition[] 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 (AlarmStateTransition c : AlarmStateTransition.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static AlarmStateTransition valueOf(java.lang.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:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
getIntValue
public int getIntValue()
-
fromIntValue
public static AlarmStateTransition fromIntValue(int value)
-
-