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

Interface AlarmDefinition

All Superinterfaces:

Countable, Extendable<PropertySet>, java.lang.Iterable<PropertyValue>, Mergable<PropertySet>, MutablePropertyValueSource, PropertySet, PropertyValueSource, java.io.Serializable

All Known Implementing Classes:

AlarmDefinitionConfig, AlarmDefinitionDiff, BasicAlarmDefinition, ExtendedAlarmDefinition, IntersectedAlarmDefinition

public interface AlarmDefinition
extends PropertySet

An AlarmDefinition is the configuration of an alarm. It is identified by its name, which must be unique inside of its parent object.

Field Summary

Fields inherited from interface com.inductiveautomation.ignition.common.config.PropertySet

EMPTY

Method Summary

Modifier and Type	Method	Description
BoundAlarmProperty	getBoundProperty(Property<?> property)
java.lang.String	getName()
boolean	isPropertyBound(Property<?> prop)
void	setBoundProperty(Property<?> property, BoundAlarmProperty value)
void	setName(java.lang.String name)

Methods inherited from interface com.inductiveautomation.ignition.common.config.Countable

getCount

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface com.inductiveautomation.ignition.common.config.Mergable

merge

Methods inherited from interface com.inductiveautomation.ignition.common.config.MutablePropertyValueSource

merge, remove, set, set

Methods inherited from interface com.inductiveautomation.ignition.common.config.PropertySet

extend, getExtension, isExtended, isInherited, newDefaultInstance, newExtension

Methods inherited from interface com.inductiveautomation.ignition.common.config.PropertyValueSource

contains, get, getNonNull, getNonNull, getOrDefault, getOrElse, getProperties, getValues

Method Detail

getName

java.lang.String getName()

setName

void setName(java.lang.String name)

isPropertyBound

boolean isPropertyBound(Property<?> prop)

setBoundProperty

void setBoundProperty(Property<?> property,
                      BoundAlarmProperty value)

getBoundProperty

BoundAlarmProperty getBoundProperty(Property<?> property)