Class PropertyTreeChangeEvent
- java.lang.Object
-
- com.inductiveautomation.perspective.gateway.property.PropertyTreeChangeEvent
-
- Direct Known Subclasses:
ContextualPropertyChangeEvent
public class PropertyTreeChangeEvent extends java.lang.Object
Event for whenever a property in a PropertyTree changes.
-
-
Field Summary
Fields Modifier and Type Field Description boolean
allowSync
com.inductiveautomation.ignition.common.gson.JsonElement
json
Json encoding of the new value af the changed path.JsonPath
listeningPath
The path to the property that was actually being listened to by the lister receiving this event.Origin
origin
Origin of the changeJsonPath
path
The path to the property that caused the change.java.util.function.Function<JsonPath,QualifiedValue>
readFunction
Supplies the value of the property that the subscriber was subscribed tojava.lang.Object
source
-
Constructor Summary
Constructors Constructor Description PropertyTreeChangeEvent(JsonPath path, JsonPath listeningPath, com.inductiveautomation.ignition.common.gson.JsonElement json, Origin origin, java.util.function.Function<JsonPath,QualifiedValue> readFunction, java.lang.Object source, boolean allowSync)
PropertyTreeChangeEvent(PropertyTreeChangeEvent copy)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description QualifiedValue
readCausalValue()
QualifiedValue
readValue()
-
-
-
Field Detail
-
path
public final JsonPath path
The path to the property that caused the change. Note that this may be a different path than that which was subscribed to, if a descendent or ancestor property change caused the subscribed path to change.
-
listeningPath
public final JsonPath listeningPath
The path to the property that was actually being listened to by the lister receiving this event.
-
json
public final com.inductiveautomation.ignition.common.gson.JsonElement json
Json encoding of the new value af the changed path.
-
origin
public final Origin origin
Origin of the change
-
readFunction
public final java.util.function.Function<JsonPath,QualifiedValue> readFunction
Supplies the value of the property that the subscriber was subscribed to
-
source
public final java.lang.Object source
-
allowSync
public final boolean allowSync
-
-
Constructor Detail
-
PropertyTreeChangeEvent
public PropertyTreeChangeEvent(JsonPath path, JsonPath listeningPath, com.inductiveautomation.ignition.common.gson.JsonElement json, Origin origin, java.util.function.Function<JsonPath,QualifiedValue> readFunction, java.lang.Object source, boolean allowSync)
-
PropertyTreeChangeEvent
public PropertyTreeChangeEvent(PropertyTreeChangeEvent copy)
-
-
Method Detail
-
readCausalValue
public QualifiedValue readCausalValue()
- Returns:
- the new value of the property whose change caused the event to be fired.
-
readValue
public QualifiedValue readValue()
- Returns:
- the new value of the property being listened to.
-
-