Package com.inductiveautomation.ignition.common.alarming.config

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>, Serializable

public class AlarmModeProperties<T>
extends WellKnownAlarmProperties<T>

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final AlarmModeProperties<Boolean>	ActiveCondition
static final AlarmModeProperties<Boolean>	AnyChange
static final AlarmModeProperties<Boolean>	BitOnZero
static final AlarmModeProperties<Integer>	BitPosition
static final AlarmModeProperties<Boolean>	InclusiveA
static final AlarmModeProperties<Boolean>	InclusiveB
static final AlarmModeProperties<AlarmMode>	Mode
static final Set<Property<?>>	MODE_PROPERTIES	All of the settings that only apply to a particular mode
static final AlarmModeProperties<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 final AlarmModeProperties<Double>	SetpointA
static final AlarmModeProperties<Double>	SetpointB

Constructor Summary

Constructors

Constructor	Description
AlarmModeProperties(String simpleName, Class<T> dtype, T defaultVal)
AlarmModeProperties(String simpleName, Class<T> dtype, T defaultVal, boolean bindable)
AlarmModeProperties(String simpleName, String displayNameKey, Class<T> dtype, T defaultVal, boolean bindable)

Method Summary

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.
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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

SetpointA

public static final AlarmModeProperties<Double> SetpointA

SetpointB

public static final AlarmModeProperties<Double> SetpointB

InclusiveA

public static final AlarmModeProperties<Boolean> InclusiveA

InclusiveB

public static final AlarmModeProperties<Boolean> InclusiveB

BitOnZero

public static final AlarmModeProperties<Boolean> BitOnZero

BitPosition

public static final AlarmModeProperties<Integer> BitPosition

ActiveCondition

public static final AlarmModeProperties<Boolean> ActiveCondition

AnyChange

public static final AlarmModeProperties<Boolean> AnyChange

OnEachEvaluation

public static final AlarmModeProperties<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 Set<Property<?>> MODE_PROPERTIES

All of the settings that only apply to a particular mode

Constructor Details

AlarmModeProperties

public AlarmModeProperties(String simpleName,
 String displayNameKey,
 Class<T> dtype,
 T defaultVal,
 boolean bindable)

AlarmModeProperties

public AlarmModeProperties(String simpleName,
 Class<T> dtype,
 T defaultVal,
 boolean bindable)

AlarmModeProperties

public AlarmModeProperties(String simpleName,
 Class<T> dtype,
 T defaultVal)

Method Details

getName

public 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."

Specified by:

getName in interface Property<T>

Overrides:

getName in class WellKnownAlarmProperties<T>

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()