Package com.inductiveautomation.ignition.common.alarming

Enum AlarmSystemEvent

java.lang.Object

java.lang.Enum<AlarmSystemEvent>

com.inductiveautomation.ignition.common.alarming.AlarmSystemEvent

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AlarmSystemEvent>

public enum AlarmSystemEvent
extends java.lang.Enum<AlarmSystemEvent>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ShelveApplied
ShelveRemoved
System_Shutdown
System_Startup

Method Summary

Modifier and Type	Method	Description
static AlarmSystemEvent	fromIntValue(int value)
QualifiedPath	getId()	Returns the description of this event as a QualifiedPath.
int	getIntValue()
static AlarmSystemEvent	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static AlarmSystemEvent[]	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

Enum Constant Detail

System_Startup

public static final AlarmSystemEvent System_Startup

System_Shutdown

public static final AlarmSystemEvent System_Shutdown

ShelveApplied

public static final AlarmSystemEvent ShelveApplied

ShelveRemoved

public static final AlarmSystemEvent ShelveRemoved

Method Detail

values

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

Returns:

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

valueOf

public static AlarmSystemEvent 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 name

java.lang.NullPointerException - if the argument is null

getId

public QualifiedPath getId()

Returns the description of this event as a QualifiedPath.

getIntValue

public int getIntValue()

fromIntValue

public static AlarmSystemEvent fromIntValue(int value)