com.inductiveautomation.ignition.common.alarming

Class BasicAlarmEvent

java.lang.Object

com.inductiveautomation.ignition.common.config.BasicPropertySet

com.inductiveautomation.ignition.common.alarming.BasicAlarmEvent

All Implemented Interfaces:

AlarmEvent, Countable, Extendable<PropertySet>, Mergable<PropertySet>, MutablePropertyValueSource, ObservablePropertySet, PropertySet, PropertyValueSource, java.io.Serializable, java.lang.Iterable<PropertyValue>

public class BasicAlarmEvent
extends BasicPropertySet
implements AlarmEvent

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.inductiveautomation.ignition.common.config.BasicPropertySet

BasicPropertySet.Builder

Field Summary

Fields inherited from interface com.inductiveautomation.ignition.common.config.PropertySet

EMPTY

Constructor Summary

Constructors

Constructor and Description
BasicAlarmEvent(QualifiedPath source, java.lang.String displayPath, AlarmPriority priority)
BasicAlarmEvent(QualifiedPath source, java.lang.String displayPath, AlarmPriority priority, java.lang.String notes)
BasicAlarmEvent(java.util.UUID id, QualifiedPath source, java.lang.String displayPath, AlarmPriority priority)
BasicAlarmEvent(java.util.UUID id, QualifiedPath source, java.lang.String displayPath, AlarmPriority priority, java.lang.String notes)
BasicAlarmEvent(java.util.UUID id, QualifiedPath source, StringPath displayPath, AlarmPriority priority, java.lang.String notes)

Method Summary

Modifier and Type	Method and Description
void	acknowledge(EventData ackData)
void	active(EventData activeData)
void	clear(EventData clearData)
boolean	contains(Property<?> prop)
boolean	equals(java.lang.Object obj)
<T> T	get(Property<T> prop) Retrieves the value of the property, or null if this set doesn't contain that property.
protected <T> T	get(Property<T> prop, boolean retDefault)
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()
<T> T	getOrDefault(Property<T> prop) Searches the various event datas for the specified property.
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, base on whether the IsShelved property is set.
java.lang.String	toString()

Methods inherited from class com.inductiveautomation.ignition.common.config.BasicPropertySet

addPropertyChangeListener, addPropertyChangeListener, change, coerceValue, firePropertyChange, getCount, getExtension, getOrElse, getProperties, getRaw, getRawValueMap, getValues, isExtended, isInherited, iterator, of, remove, removePropertyChangeListener, removePropertyChangeListener, set, set, setDirect, setImpl, setRawValueMap

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.inductiveautomation.ignition.common.config.PropertySet

builder, extend, getExtension, isExtended, isInherited, newDefaultInstance, newExtension

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface com.inductiveautomation.ignition.common.config.MutablePropertyValueSource

merge, remove, set, set

Methods inherited from interface com.inductiveautomation.ignition.common.config.PropertyValueSource

getOrElse, getProperties, getValues

Methods inherited from interface com.inductiveautomation.ignition.common.config.Mergable

merge

Methods inherited from interface com.inductiveautomation.ignition.common.config.Countable

getCount

Constructor Detail

BasicAlarmEvent

public BasicAlarmEvent(QualifiedPath source,
                       java.lang.String displayPath,
                       AlarmPriority priority)

BasicAlarmEvent

public BasicAlarmEvent(QualifiedPath source,
                       java.lang.String displayPath,
                       AlarmPriority priority,
                       java.lang.String notes)

BasicAlarmEvent

public BasicAlarmEvent(java.util.UUID id,
                       QualifiedPath source,
                       java.lang.String displayPath,
                       AlarmPriority priority)

BasicAlarmEvent

public BasicAlarmEvent(java.util.UUID id,
                       QualifiedPath source,
                       java.lang.String displayPath,
                       AlarmPriority priority,
                       java.lang.String notes)

BasicAlarmEvent

public BasicAlarmEvent(java.util.UUID id,
                       QualifiedPath source,
                       StringPath displayPath,
                       AlarmPriority priority,
                       java.lang.String notes)

Method Detail

getId

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

Specified by:

getId in interface AlarmEvent

getSource

public QualifiedPath getSource()

The path to the alarm that generated this event.

Specified by:

getSource in interface AlarmEvent

getName

public java.lang.String getName()

Specified by:

getName in interface AlarmEvent

getPriority

public AlarmPriority getPriority()

Returns the priority of the alarm event.

Specified by:

getPriority in interface AlarmEvent

getDisplayPath

public StringPath getDisplayPath()

Specified by:

getDisplayPath in interface AlarmEvent

getDisplayPathOrSource

public java.lang.String getDisplayPathOrSource()

Specified by:

getDisplayPathOrSource in interface AlarmEvent

getLabel

public java.lang.String getLabel()

Description copied from interface: AlarmEvent

Returns the "Label" property, or "Name" if not defined.

Specified by:

getLabel in interface AlarmEvent

active

public void active(EventData activeData)

Specified by:

active in interface AlarmEvent

acknowledge

public void acknowledge(EventData ackData)

Specified by:

acknowledge in interface AlarmEvent

clear

public void clear(EventData clearData)

Specified by:

clear in interface AlarmEvent

isCleared

public boolean isCleared()

Specified by:

isCleared in interface AlarmEvent

isAcked

public boolean isAcked()

Specified by:

isAcked in interface AlarmEvent

isShelved

public 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, base on whether the IsShelved property is set.

Specified by:

isShelved in interface AlarmEvent

getState

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

Specified by:

getState in interface AlarmEvent

getLastEventState

public AlarmStateTransition getLastEventState()

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

Specified by:

getLastEventState in interface AlarmEvent

getActiveData

public EventData getActiveData()

Specified by:

getActiveData in interface AlarmEvent

getClearedData

public EventData getClearedData()

Specified by:

getClearedData in interface AlarmEvent

getAckData

public EventData getAckData()

Specified by:

getAckData in interface AlarmEvent

getNotes

public java.lang.String getNotes()

Specified by:

getNotes in interface AlarmEvent

getOrDefault

public <T> T getOrDefault(Property<T> prop)

Searches the various event datas for the specified property. Looks in the order: Ack, Clear, Active, according to the state the event is in. If not found, the default is returned.

Specified by:

getOrDefault in interface PropertyValueSource

Overrides:

getOrDefault in class BasicPropertySet

Returns:

The value for prop or Property.getDefaultValue() if not present.

get

public <T> T get(Property<T> prop)

Description copied from interface: PropertyValueSource

Retrieves the value of the property, or null if this set doesn't contain that property.

Specified by:

get in interface PropertyValueSource

Overrides:

get in class BasicPropertySet

get

protected <T> T get(Property<T> prop,
                    boolean retDefault)

contains

public boolean contains(Property<?> prop)

Specified by:

contains in interface PropertyValueSource

Overrides:

contains in class BasicPropertySet

Returns:

True if the source contains a value for prop.

toString

public java.lang.String toString()

Overrides:

toString in class BasicPropertySet

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class BasicPropertySet