Package com.inductiveautomation.ignition.common.alarming

Enum Class AlarmStateTransition

java.lang.Object

java.lang.Enum<AlarmStateTransition>

com.inductiveautomation.ignition.common.alarming.AlarmStateTransition

All Implemented Interfaces:

Serializable, Comparable<AlarmStateTransition>, Constable

public enum AlarmStateTransition
extends 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.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
Ack
Active
Clear
Disabled	This transition is used to indicate that an alarm event is no longer "live" due to alarm being force disabled.
Enabled	This transition is used to indicate that the alarm event has become "live" due to alarm being force enabled.
Finished	This transition is used to indicate that an alarm event is no longer needed and should drop out of the system.
Shelved	This transition is used to indicate when an alarm is first shelved.

Method Summary

Modifier and Type	Method	Description
static AlarmStateTransition	fromIntValue(int value)
int	getIntValue()
static AlarmStateTransition	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AlarmStateTransition[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

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.

Enabled

public static final AlarmStateTransition Enabled

This transition is used to indicate that the alarm event has become "live" due to alarm being force enabled. This will immediately be followed by an active or a clear transition.

Disabled

public static final AlarmStateTransition Disabled

This transition is used to indicate that an alarm event is no longer "live" due to alarm being force disabled. This will immediately be followed by a finished transition.

Shelved

public static final AlarmStateTransition Shelved

This transition is used to indicate when an alarm is first shelved.

Method Details

values

public static AlarmStateTransition[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static AlarmStateTransition valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getIntValue

public int getIntValue()

fromIntValue

public static AlarmStateTransition fromIntValue(int value)