Interface AlarmEvaluator
-
- All Superinterfaces:
BrowsableNode
,Diagnosable
,Node
public interface AlarmEvaluator extends Diagnosable, BrowsableNode
The alarm evaluator is the unit that takes a value, and determines whether it is in alarm or not. It is created by theAlarmManager
based on anAlarmConfiguration
. When the entity that is feeding it values is destroyed, it should call release() so that the alarming system knows that the alarm is no longer in use.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
evaluate(QualifiedValue value)
Evaluates a value against the configured conditions.AlarmStateSummary
getState()
boolean
isEvaluationEnabled()
Indicates whether this AlarmEvaluator is enabled.void
reattach()
Re-activates the alarm after release() has been called.void
release()
Releases the alarm evaluator, deregistering the alarm configuration from the system.void
setAlarmObserver(AlarmObserver value)
Each alarm can have one observer, that will be notified about transitions.Note: The observer is cleared when release() is called, and therefore should be re-added when calling reattach();void
setEvaluationEnabled(boolean value)
Sets whether or not the alarm should evaluate.-
Methods inherited from interface com.inductiveautomation.ignition.gateway.tags.evaluation.nodes.BrowsableNode
browse, browse, getBrowseInfo, getChildNode, getPropertyNode, hasChildren
-
Methods inherited from interface com.inductiveautomation.ignition.common.Diagnosable
sampleDiagnostics
-
Methods inherited from interface com.inductiveautomation.ignition.gateway.tags.evaluation.nodes.Node
read, setLeased, setSubscription, write
-
-
-
-
Method Detail
-
getState
AlarmStateSummary getState()
-
evaluate
void evaluate(QualifiedValue value)
Evaluates a value against the configured conditions.
-
release
void release()
Releases the alarm evaluator, deregistering the alarm configuration from the system.
-
reattach
void reattach()
Re-activates the alarm after release() has been called. If an alarm observer is being used, it should be re-added before calling this function.
-
setEvaluationEnabled
void setEvaluationEnabled(boolean value)
Sets whether or not the alarm should evaluate. This is treated separately from the alarm's enabled property. In other words, in order to evaluate, this evaluator must be enabled, and the alarm must indicate that it is enabled through the property.Note: When this is set to false, all live events will transition to "finished".
-
isEvaluationEnabled
boolean isEvaluationEnabled()
Indicates whether this AlarmEvaluator is enabled. The alarm itself, through its Enabled property, must still not be enabled.
-
setAlarmObserver
void setAlarmObserver(AlarmObserver value)
Each alarm can have one observer, that will be notified about transitions.Note: The observer is cleared when release() is called, and therefore should be re-added when calling reattach();
-
-