Package com.inductiveautomation.ignition.gateway.alarming.evaluation

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 the AlarmManager based on an AlarmConfiguration. 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 Details

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

    • addAlarmObserver

      void addAlarmObserver(AlarmObserver alarmObserver)
      Alarms can have multiple observers, each observer will be notified about transitions.Note: Observers are cleared when release() is called, and therefore should be re-added when calling reattach();
      Parameters:
      alarmObserver - The observer to be removed.

    • removeAlarmObserver

      void removeAlarmObserver(AlarmObserver alarmObserver)
      Removes the specified alarm observer from the list of observers. The observer will no longer receive notifications about alarm transitions.
      Parameters:
      alarmObserver - The observer to be removed.