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 SummaryEnum Constants Enum Constant Description ALARM_FLAGSALARM_TYPEDATEDISPLAY_PATHFOLDER_PATHGROUP_NAMEITEM_NAMEITEM_PATHITEM_UNITSNOTESPREVIOUS_VALUESEVERITYSTATE_NAMESYSTEMTIMEVALUE
 - 
Method SummaryAll 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.ObjectgetFrom(AlertMessage m)Gets the variable from the given alert message.static AlertVariablevalueOf(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- 
DATEpublic static final AlertVariable DATE 
 - 
TIMEpublic static final AlertVariable TIME 
 - 
VALUEpublic static final AlertVariable VALUE 
 - 
PREVIOUS_VALUEpublic static final AlertVariable PREVIOUS_VALUE 
 - 
ITEM_NAMEpublic static final AlertVariable ITEM_NAME 
 - 
GROUP_NAMEpublic static final AlertVariable GROUP_NAME 
 - 
FOLDER_PATHpublic static final AlertVariable FOLDER_PATH 
 - 
STATE_NAMEpublic static final AlertVariable STATE_NAME 
 - 
ALARM_FLAGSpublic static final AlertVariable ALARM_FLAGS 
 - 
ALARM_TYPEpublic static final AlertVariable ALARM_TYPE 
 - 
ITEM_PATHpublic static final AlertVariable ITEM_PATH 
 - 
SEVERITYpublic static final AlertVariable SEVERITY 
 - 
ITEM_UNITSpublic static final AlertVariable ITEM_UNITS 
 - 
DISPLAY_PATHpublic static final AlertVariable DISPLAY_PATH 
 - 
NOTESpublic static final AlertVariable NOTES 
 - 
SYSTEMpublic static final AlertVariable SYSTEM 
 
- 
 - 
Method Detail- 
valuespublic 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
 
 - 
valueOfpublic 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 name
- java.lang.NullPointerException- if the argument is null
 
 - 
getDataTypepublic java.lang.Class<?> getDataType() 
 - 
getFrompublic java.lang.Object getFrom(AlertMessage m) Gets the variable from the given alert message. Some legacy variables don't map over.
 - 
getDisplayListpublic java.util.List<java.lang.String> getDisplayList() 
 
- 
 
-