Interface AlarmEvent
-
- All Superinterfaces:
Countable
,Extendable<PropertySet>
,java.lang.Iterable<PropertyValue>
,Mergable<PropertySet>
,MutablePropertyValueSource
,PropertySet
,PropertyValueSource
,java.io.Serializable
- 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.
-
-
Field Summary
-
Fields inherited from interface com.inductiveautomation.ignition.common.config.PropertySet
EMPTY
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
acknowledge(EventData ackData)
void
active(EventData activeData)
void
clear(EventData clearData)
EventData
getAckData()
EventData
getActiveData()
EventData
getClearedData()
StringPath
getDisplayPath()
java.lang.String
getDisplayPathOrSource()
java.util.UUID
getId()
The unique id for this event.java.lang.String
getLabel()
Returns the "Label" property, or "Name" if not defined.AlarmStateTransition
getLastEventState()
Returns the most recent transition, or if this event represents a single state, the particular state that it represents.java.lang.String
getName()
java.lang.String
getNotes()
AlarmPriority
getPriority()
Returns the priority of the alarm event.QualifiedPath
getSource()
The path to the alarm that generated this event.AlarmState
getState()
Returns the current state, as an enum.boolean
isAcked()
boolean
isCleared()
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.-
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
-
getId
java.util.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
java.lang.String getName()
-
getPriority
AlarmPriority getPriority()
Returns the priority of the alarm event.
-
getDisplayPath
StringPath getDisplayPath()
-
getDisplayPathOrSource
java.lang.String getDisplayPathOrSource()
-
getLabel
java.lang.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
java.lang.String getNotes()
-
-