Package com.inductiveautomation.perspective.gateway.property

Class PropertyTreeChangeEvent

java.lang.Object

com.inductiveautomation.perspective.gateway.property.PropertyTreeChangeEvent

Direct Known Subclasses:

ContextualPropertyChangeEvent

public class PropertyTreeChangeEvent
extends Object

Event for whenever a property in a PropertyTree changes.

Field Summary

Fields

Modifier and Type	Field	Description
final boolean	allowSync
final com.inductiveautomation.ignition.common.gson.JsonElement	json	Json encoding of the new value af the changed path.
final JsonPath	listeningPath	The path to the property that was actually being listened to by the lister receiving this event.
final Origin	origin	Origin of the change
final JsonPath	path	The path to the property that caused the change.
final Function<JsonPath,QualifiedValue>	readFunction	Supplies the value of the property that the subscriber was subscribed to
final Object	source

Constructor Summary

Constructors

Constructor	Description
PropertyTreeChangeEvent(JsonPath path, JsonPath listeningPath, com.inductiveautomation.ignition.common.gson.JsonElement json, Origin origin, Function<JsonPath,QualifiedValue> readFunction, Object source, boolean allowSync)
PropertyTreeChangeEvent(PropertyTreeChangeEvent copy)

Method Summary

Modifier and Type	Method	Description
QualifiedValue	readCausalValue()
QualifiedValue	readValue()

Methods inherited from class java.lang.Object

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

Field Details

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 Function<JsonPath,QualifiedValue> readFunction

Supplies the value of the property that the subscriber was subscribed to

source

public final Object source

allowSync

public final boolean allowSync

Constructor Details

PropertyTreeChangeEvent

public PropertyTreeChangeEvent(JsonPath path,
 JsonPath listeningPath,
 com.inductiveautomation.ignition.common.gson.JsonElement json,
 Origin origin,
 Function<JsonPath,QualifiedValue> readFunction,
 Object source,
 boolean allowSync)

PropertyTreeChangeEvent

public PropertyTreeChangeEvent(PropertyTreeChangeEvent copy)

Method Details

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.