Package com.inductiveautomation.ignition.common.alarming

Interface AlarmEvent

All Superinterfaces:
Countable, Extendable<PropertySet>, Iterable<PropertyValue>, Mergable<PropertySet>, MutablePropertyValueSource, PropertySet, PropertyValueSource, Serializable
All Known Subinterfaces:
PyAlarmEvent
All Known Implementing Classes:
AlarmEventInstance, BasicAlarmEvent, PyAlarmEventImpl
public interface AlarmEvent extends PropertySet
The alarm event transports all information about a particular alarm instance. It is generally generated when the alarm goes active, and then updated during the lifecycle of the event. The Alarm Event object contains details for each stage of the alarm cycle - active, clear, ack. However, the object itself extends from PropertySet, and contains properties that pertain to its overall lifecycle. These might be updated by the pipeline system, for example. The calls to getOrDefault and contains first search through the event data (ack to clear to active), and then to the base data, and therefore can be used in most cases that a property is required.

  • Method Details

    • getId

      UUID getId()
      The unique id for this event. Generated when the alarm is first generated, and then maintained for the life of the alarm event cycle.

    • getSource

      QualifiedPath getSource()
      The path to the alarm that generated this event.

    • getName

      String getName()

    • getPriority

      AlarmPriority getPriority()
      Returns the priority of the alarm event.

    • getDisplayPath

      StringPath getDisplayPath()

    • getDisplayPathOrSource

      String getDisplayPathOrSource()

    • getLabel

      String getLabel()
      Returns the "Label" property, or "Name" if not defined.

    • active

      void active(EventData activeData)

    • acknowledge

      void acknowledge(EventData ackData)

    • clear

      void clear(EventData clearData)

    • isCleared

      boolean isCleared()

    • isAcked

      boolean isAcked()

    • isShelved

      boolean isShelved()
      Returns whether this is event is currently shelved, if the ShelfExpiration property is set, or whether the event was shelved, for journaled events, based on whether the IsShelved property is set.

    • getState

      AlarmState getState()
      Returns the current state, as an enum. If this event represents a single state, such as the result from a journal query, this value will be misleading. In that case, getLastEventState() is the more accurate state function to use.

    • getLastEventState

      AlarmStateTransition getLastEventState()
      Returns the most recent transition, or if this event represents a single state, the particular state that it represents.

    • getActiveData

      EventData getActiveData()

    • getClearedData

      EventData getClearedData()

    • getAckData

      EventData getAckData()

    • getNotes

      String getNotes()