Class AlarmModeProperties<T>
- java.lang.Object
-
- com.inductiveautomation.ignition.common.alarming.config.WellKnownAlarmProperties<T>
-
- com.inductiveautomation.ignition.common.alarming.config.AlarmModeProperties<T>
-
- All Implemented Interfaces:
AlarmProperty<T>
,DescriptiveProperty<T>
,Property<T>
,java.io.Serializable
public class AlarmModeProperties<T> extends WellKnownAlarmProperties<T>
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static AlarmModeProperties<java.lang.Boolean>
ActiveCondition
static AlarmModeProperties<java.lang.Boolean>
AnyChange
static AlarmModeProperties<java.lang.Boolean>
BitOnZero
static AlarmModeProperties<java.lang.Integer>
BitPosition
static AlarmModeProperties<java.lang.Boolean>
InclusiveA
static AlarmModeProperties<java.lang.Boolean>
InclusiveB
static AlarmModeProperties<AlarmMode>
Mode
static java.util.Set<Property<?>>
MODE_PROPERTIES
All of the settings that only apply to a particular modestatic AlarmModeProperties<java.lang.Boolean>
OnEachEvaluation
This is a special api setting that can be used with anychange to mean "go into alarm each evaluation", as in, each time a value is set.static AlarmModeProperties<java.lang.Double>
SetpointA
static AlarmModeProperties<java.lang.Double>
SetpointB
-
Constructor Summary
Constructors Constructor Description AlarmModeProperties(java.lang.String simpleName, java.lang.Class<T> dtype, T defaultVal)
AlarmModeProperties(java.lang.String simpleName, java.lang.Class<T> dtype, T defaultVal, boolean bindable)
AlarmModeProperties(java.lang.String simpleName, java.lang.String displayNameKey, java.lang.Class<T> dtype, T defaultVal, boolean bindable)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description LocalizedString
getCategory()
The category under which this property will be placed when editing.LocalizedString
getDescription()
Optional description/documentation for the property.LocalizedString
getDisplayName()
A friendly display name for the property.java.lang.String
getName()
The "name" of this property.static Property<?>[]
values()
-
Methods inherited from class com.inductiveautomation.ignition.common.alarming.config.WellKnownAlarmProperties
equals, getDefaultValue, getType, hashCode, isAdvanced, isBindable, name, toString, values
-
-
-
-
Field Detail
-
SetpointA
public static final AlarmModeProperties<java.lang.Double> SetpointA
-
SetpointB
public static final AlarmModeProperties<java.lang.Double> SetpointB
-
InclusiveA
public static final AlarmModeProperties<java.lang.Boolean> InclusiveA
-
InclusiveB
public static final AlarmModeProperties<java.lang.Boolean> InclusiveB
-
BitOnZero
public static final AlarmModeProperties<java.lang.Boolean> BitOnZero
-
BitPosition
public static final AlarmModeProperties<java.lang.Integer> BitPosition
-
ActiveCondition
public static final AlarmModeProperties<java.lang.Boolean> ActiveCondition
-
AnyChange
public static final AlarmModeProperties<java.lang.Boolean> AnyChange
-
OnEachEvaluation
public static final AlarmModeProperties<java.lang.Boolean> OnEachEvaluation
This is a special api setting that can be used with anychange to mean "go into alarm each evaluation", as in, each time a value is set.
-
Mode
public static final AlarmModeProperties<AlarmMode> Mode
-
MODE_PROPERTIES
public static final java.util.Set<Property<?>> MODE_PROPERTIES
All of the settings that only apply to a particular mode
-
-
Constructor Detail
-
AlarmModeProperties
public AlarmModeProperties(java.lang.String simpleName, java.lang.String displayNameKey, java.lang.Class<T> dtype, T defaultVal, boolean bindable)
-
AlarmModeProperties
public AlarmModeProperties(java.lang.String simpleName, java.lang.Class<T> dtype, T defaultVal, boolean bindable)
-
-
Method Detail
-
getName
public java.lang.String getName()
Description copied from interface:Property
The "name" of this property. Should be descriptive, but also unique. To this end, it is encouraged to make your keys fully qualified by prefixing them with your module id. For example: "mymod.MyProperty". Properties defined by the system start with "sys."
-
getDisplayName
public LocalizedString getDisplayName()
Description copied from interface:DescriptiveProperty
A friendly display name for the property. If not set, will return a raw LocalizedString that contains the property name.
-
getCategory
public LocalizedString getCategory()
Description copied from interface:DescriptiveProperty
The category under which this property will be placed when editing.
-
getDescription
public LocalizedString getDescription()
Description copied from interface:DescriptiveProperty
Optional description/documentation for the property. May return null if no information is available.
-
values
public static Property<?>[] values()
-
-