Enum AlertVariable
- java.lang.Object
-
- java.lang.Enum<AlertVariable>
-
- com.inductiveautomation.ignition.gateway.alert.AlertVariable
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<AlertVariable>
public enum AlertVariable extends java.lang.Enum<AlertVariable>
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ALARM_FLAGS
ALARM_TYPE
DATE
DISPLAY_PATH
FOLDER_PATH
GROUP_NAME
ITEM_NAME
ITEM_PATH
ITEM_UNITS
NOTES
PREVIOUS_VALUE
SEVERITY
STATE_NAME
SYSTEM
TIME
VALUE
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Class<?>
getDataType()
java.util.List<java.lang.String>
getDisplayList()
java.lang.Object
getFrom(AlertMessage m)
Gets the variable from the given alert message.static AlertVariable
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static AlertVariable[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
DATE
public static final AlertVariable DATE
-
TIME
public static final AlertVariable TIME
-
VALUE
public static final AlertVariable VALUE
-
PREVIOUS_VALUE
public static final AlertVariable PREVIOUS_VALUE
-
ITEM_NAME
public static final AlertVariable ITEM_NAME
-
GROUP_NAME
public static final AlertVariable GROUP_NAME
-
FOLDER_PATH
public static final AlertVariable FOLDER_PATH
-
STATE_NAME
public static final AlertVariable STATE_NAME
-
ALARM_FLAGS
public static final AlertVariable ALARM_FLAGS
-
ALARM_TYPE
public static final AlertVariable ALARM_TYPE
-
ITEM_PATH
public static final AlertVariable ITEM_PATH
-
SEVERITY
public static final AlertVariable SEVERITY
-
ITEM_UNITS
public static final AlertVariable ITEM_UNITS
-
DISPLAY_PATH
public static final AlertVariable DISPLAY_PATH
-
NOTES
public static final AlertVariable NOTES
-
SYSTEM
public static final AlertVariable SYSTEM
-
-
Method Detail
-
values
public static AlertVariable[] 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 (AlertVariable c : AlertVariable.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static AlertVariable 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
-
getDataType
public java.lang.Class<?> getDataType()
-
getFrom
public java.lang.Object getFrom(AlertMessage m)
Gets the variable from the given alert message. Some legacy variables don't map over.
-
getDisplayList
public java.util.List<java.lang.String> getDisplayList()
-
-