com.inductiveautomation.ignition.gateway.sqltags.execution.tags

Class AbstractExecutableTag.AlarmConfigHarness

java.lang.Object

com.inductiveautomation.ignition.gateway.sqltags.execution.tags.AbstractExecutableTag.AlarmConfigHarness

All Implemented Interfaces:

Diagnosable, AlarmEvaluator

Enclosing class:

AbstractExecutableTag

protected class AbstractExecutableTag.AlarmConfigHarness
extends java.lang.Object
implements AlarmEvaluator

This is a bit of a trick to deal with how we have to initialize tags in a memory efficient manner. The alarm can't be initialized until the tag is started, but we don't want to hold on to the config forever. So, we make this fake alarm evaluator that we init later.

Constructor Summary

Constructors

Constructor and Description
AlarmConfigHarness(AlarmConfiguration config)

Method Summary

Modifier and Type	Method and Description
void	evaluate(QualifiedValue value) Evaluates a value against the configured conditions.
AlarmStateSummary	getState()
AlarmEvaluator	initialize()
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	sampleDiagnostics(DiagnosticsSample sample) Provides the sample upon which the object can set diagnostics information.
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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AlarmConfigHarness

public AlarmConfigHarness(AlarmConfiguration config)

Method Detail

initialize

public AlarmEvaluator initialize()

evaluate

public void evaluate(QualifiedValue value)

Description copied from interface: AlarmEvaluator

Evaluates a value against the configured conditions.

Specified by:

evaluate in interface AlarmEvaluator

release

public void release()

Description copied from interface: AlarmEvaluator

Releases the alarm evaluator, deregistering the alarm configuration from the system.

Specified by:

release in interface AlarmEvaluator

reattach

public void reattach()

Description copied from interface: AlarmEvaluator

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.

Specified by:

reattach in interface AlarmEvaluator

getState

public AlarmStateSummary getState()

Specified by:

getState in interface AlarmEvaluator

isEvaluationEnabled

public boolean isEvaluationEnabled()

Description copied from interface: AlarmEvaluator

Indicates whether this AlarmEvaluator is enabled. The alarm itself, through its Enabled property, must still not be enabled.

Specified by:

isEvaluationEnabled in interface AlarmEvaluator

setEvaluationEnabled

public void setEvaluationEnabled(boolean value)

Description copied from interface: AlarmEvaluator

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

Specified by:

setEvaluationEnabled in interface AlarmEvaluator

setAlarmObserver

public void setAlarmObserver(AlarmObserver value)

Description copied from interface: AlarmEvaluator

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

Specified by:

setAlarmObserver in interface AlarmEvaluator

sampleDiagnostics

public void sampleDiagnostics(DiagnosticsSample sample)

Description copied from interface: Diagnosable

Provides the sample upon which the object can set diagnostics information. It is expected that the calling object will first call getSubSample() in order to specify a useful identifier for this object's data.

Specified by:

sampleDiagnostics in interface Diagnosable