AlarmEventInstance

java.lang.Object
- com.inductiveautomation.ignition.common.alarming.AlarmEventInstance

All Implemented Interfaces:

AlarmEvent, Countable, Mergable<PropertySet>, MutablePropertyValueSource, PropertySet, PropertyValueSource, java.io.Serializable, java.lang.Iterable<PropertyValue>
```
public class AlarmEventInstance
extends java.lang.Object
implements AlarmEvent
```
Alarm events normally exist as a single object in the system. However, in some cases (such as pipelines), we need to send the same event off in different directions, and we don't want to share the state between them. This class is used to create a new instance, which stores its own state, but still has a reference to the core event.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`AlarmEventInstance(AlarmEvent core)`
`AlarmEventInstance(AlarmEvent core, AlarmStateTransition transition)` Convenience constructor for branching on new state transition *

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`acknowledge(EventData ackData)`
`void`	`active(EventData activeData)`
`static AlarmEventInstance`	`branch(AlarmEvent event)` Creates a new instance, incrementing the BranchDepth property.
`void`	`clear(EventData clearData)`
`boolean`	`contains(Property<?> prop)`
`<T> T`	`get(Property<T> prop)` Retrieves the value of the property, or `null` if this set doesn't contain that property.
`EventData`	`getAckData()`
`EventData`	`getActiveData()`
`EventData`	`getClearedData()`
`int`	`getCount()`
`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.
`PropertySet`	`getLocals()`
`java.lang.String`	`getName()`
`java.lang.String`	`getNotes()`
`<T> T`	`getOrDefault(Property<T> prop)`
`<T> T`	`getOrElse(Property<T> property, T value)` Get the value for a given `Property`, or else fall back to `value` if it's not present.
`AlarmPriority`	`getPriority()` Returns the priority of the alarm event.
`java.util.Collection<Property<?>>`	`getProperties()`
`QualifiedPath`	`getSource()` The path to the alarm that generated this event.
`AlarmState`	`getState()` Returns the current state, as an enum.
`java.util.List<PropertyValue>`	`getValues()`
`boolean`	`isAcked()`
`boolean`	`isCleared()`
`boolean`	`isExtended(Property<?> prop)` Returns whether this property set contains a value for the prop, and the prop was actually inherited.
`boolean`	`isInherited(Property<?> prop)` Indicates whether the property was inherited from a parent type.
`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.util.Iterator<PropertyValue>`	`iterator()`
`void`	`merge(PropertySet other)` Merges the values from other collection into this one.
`void`	`remove(Property<?> prop)`
`<T> void`	`set(Property<T> prop, T value)`
`void`	`set(PropertyValue propValue)`
`<T> void`	`setGlobal(Property<T> p, T value)`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - AlarmEventInstance
```
public AlarmEventInstance(AlarmEvent core)
```
  - AlarmEventInstance
```
public AlarmEventInstance(AlarmEvent core,
                          AlarmStateTransition transition)
```
    Convenience constructor for branching on new state transition *
- Method Detail
  - branch
```
public static AlarmEventInstance branch(AlarmEvent event)
```
    Creates a new instance, incrementing the BranchDepth property.
  - getLocals
```
public PropertySet getLocals()
```
  - getLastEventState
```
public AlarmStateTransition getLastEventState()
```
    Description copied from interface: AlarmEvent
    
    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
  - contains
```
public boolean contains(Property<?> prop)
```
    Specified by:
    
    contains in interface PropertyValueSource
    
    Returns:
    
    True if the source contains a value for prop.
  - getOrDefault
```
public <T> T getOrDefault(Property<T> prop)
```
    Specified by:
    
    getOrDefault in interface PropertyValueSource
    
    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
  - iterator
```
public java.util.Iterator<PropertyValue> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<PropertyValue>
  - set
```
public <T> void set(Property<T> prop,
                    T value)
```
    Specified by:
    
    set in interface MutablePropertyValueSource
  - setGlobal
```
public <T> void setGlobal(Property<T> p,
                          T value)
```
  - getOrElse
```
public <T> T getOrElse(Property<T> property,
                       T value)
```
    Description copied from interface: PropertyValueSource
    
    Get the value for a given Property, or else fall back to value if it's not present.
    
    Specified by:
    
    getOrElse in interface PropertyValueSource
    
    Parameters:
    
    property - The Property for which a value is to be retrieved.
    
    value - The value to default to if property isn't present.
    
    Returns:
    
    The value of property if present, value if not.
  - set
```
public void set(PropertyValue propValue)
```
    Specified by:
    
    set in interface MutablePropertyValueSource
  - remove
```
public void remove(Property<?> prop)
```
    Specified by:
    
    remove in interface MutablePropertyValueSource
  - getCount
```
public int getCount()
```
    Specified by:
    
    getCount in interface Countable
  - getProperties
```
public java.util.Collection<Property<?>> getProperties()
```
    Specified by:
    
    getProperties in interface PropertySet
  - getValues
```
public java.util.List<PropertyValue> getValues()
```
    Specified by:
    
    getValues in interface PropertySet
  - getId
```
public java.util.UUID getId()
```
    Description copied from interface: AlarmEvent
    
    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
  - isExtended
```
public boolean isExtended(Property<?> prop)
```
    Description copied from interface: PropertyValueSource
    
    Returns whether this property set contains a value for the prop, and the prop was actually inherited. In other words, this is true if the property is inherited, and an override value is present.
    
    Specified by:
    
    isExtended in interface PropertyValueSource
  - isInherited
```
public boolean isInherited(Property<?> prop)
```
    Description copied from interface: PropertyValueSource
    
    Indicates whether the property was inherited from a parent type.
    
    Specified by:
    
    isInherited in interface PropertyValueSource
  - merge
```
public void merge(PropertySet other)
```
    Description copied from interface: Mergable
    
    Merges the values from other collection into this one. Replaces any currently existing value with those from the other set.
    
    Specified by:
    
    merge in interface Mergable<PropertySet>
  - getSource
```
public QualifiedPath getSource()
```
    Description copied from interface: AlarmEvent
    
    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()
```
    Description copied from interface: AlarmEvent
    
    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()
```
    Description copied from interface: AlarmEvent
    
    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()
```
    Description copied from interface: AlarmEvent
    
    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
  - 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
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getNotes
```
public java.lang.String getNotes()
```
    Specified by:
    
    getNotes in interface AlarmEvent

Class AlarmEventInstance

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

AlarmEventInstance

AlarmEventInstance

Method Detail

branch

getLocals

getLastEventState

contains

getOrDefault

get

iterator

set

setGlobal

getOrElse

set

remove

getCount

getProperties

getValues

getId

isExtended

isInherited

merge

getSource

getName

getPriority

getDisplayPath

getDisplayPathOrSource

getLabel

active

acknowledge

clear

isCleared

isAcked

isShelved

getState

getActiveData

getClearedData

getAckData

toString

getNotes