Package com.inductiveautomation.ignition.common.alarming

Enum Class AlarmState

java.lang.Object

java.lang.Enum<AlarmState>

com.inductiveautomation.ignition.common.alarming.AlarmState

All Implemented Interfaces:

Localized, Serializable, Comparable<AlarmState>, Constable

public enum AlarmState
extends Enum<AlarmState>
implements Localized

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
ActiveAcked
ActiveUnacked
ClearAcked
ClearUnacked
Disabled
Enabled

Method Summary

Modifier and Type	Method	Description
AlarmState	acknowledge()	A convenience function to get the next state when the current one is acknowledged.
static AlarmState	get(boolean clear, boolean ack)
boolean	isAcked()	A convenience function for telling whether this is one of the acknowledged states or not.
boolean	isActive()	Convenience function for telling whether this is one of the active states.
boolean	isEquivilent(Object o)
static List<AlarmState>	standardStates()
String	toString()
String	toString(Locale locale)
static AlarmState	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AlarmState[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ClearUnacked

public static final AlarmState ClearUnacked

ClearAcked

public static final AlarmState ClearAcked

ActiveUnacked

public static final AlarmState ActiveUnacked

ActiveAcked

public static final AlarmState ActiveAcked

Enabled

public static final AlarmState Enabled

Disabled

public static final AlarmState Disabled

Method Details

values

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

isAcked

public boolean isAcked()

A convenience function for telling whether this is one of the acknowledged states or not.

isActive

public boolean isActive()

Convenience function for telling whether this is one of the active states.

acknowledge

public AlarmState acknowledge()

A convenience function to get the next state when the current one is acknowledged.

isEquivilent

public boolean isEquivilent(Object o)

get

public static AlarmState get(boolean clear,
 boolean ack)

toString

public String toString()

Overrides:

toString in class Enum<AlarmState>

toString

public String toString(Locale locale)

Specified by:

toString in interface Localized

standardStates

public static List<AlarmState> standardStates()