Module com.esri.arcgisruntime

Package com.esri.arcgisruntime.realtime

Class DynamicEntityChangedInfo

java.lang.Object

com.esri.arcgisruntime.realtime.DynamicEntityChangedInfo

public final class DynamicEntityChangedInfo
extends Object

Describes changes to a DynamicEntity sent by DynamicEntity.DynamicEntityChangedEvent.

An object of this type is sent as an argument to the DynamicEntity.DynamicEntityChangedEvent. This event is raised whenever observations associated with an existing dynamic entity are received from the data source or purged from the local data cache.

If the last observation has been purged from the local data cache, the dynamicEntityPurgedProperty() property is set to true. This indicates that the dynamic entity has been purged and will receive no more associated observations from the data source.

Since:

200.1.0

Property Summary

Properties

Type	Property	Description
ReadOnlyBooleanProperty	dynamicEntityPurged	Indicates whether the DynamicEntity itself has been purged.
ReadOnlyObjectProperty<DynamicEntityObservation>	purgedObservation	The purged DynamicEntityObservation.
ReadOnlyObjectProperty<DynamicEntityObservation>	receivedObservation	The newly received DynamicEntityObservation.

Method Summary

Modifier and Type	Method	Description
ReadOnlyBooleanProperty	dynamicEntityPurgedProperty()	Indicates whether the DynamicEntity itself has been purged.
DynamicEntityObservation	getPurgedObservation()	Gets the value of the purgedObservation property.
DynamicEntityObservation	getReceivedObservation()	Gets the value of the receivedObservation property.
boolean	isDynamicEntityPurged()	Gets the value of the dynamicEntityPurged property.
ReadOnlyObjectProperty<DynamicEntityObservation>	purgedObservationProperty()	The purged DynamicEntityObservation.
ReadOnlyObjectProperty<DynamicEntityObservation>	receivedObservationProperty()	The newly received DynamicEntityObservation.

Methods inherited from class java.lang.Object

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

Property Details

dynamicEntityPurged

public ReadOnlyBooleanProperty dynamicEntityPurgedProperty

Indicates whether the DynamicEntity itself has been purged.

This flag is set when the last observation associated with this dynamic entity has been purged from the local data cache. In this case, the dynamic entity is also purged and will not be associated with any new observations received from the data source.

Purge of a dynamic entity can be caused by exceeding the limits defined by DynamicEntityDataSource.purgeOptionsProperty() or by an explicit call to DynamicEntityDataSource.purgeAllAsync().

The default is false.

Since:

200.1.0

See Also:

• isDynamicEntityPurged()
• dynamicEntityPurgedProperty()

purgedObservation

public ReadOnlyObjectProperty<DynamicEntityObservation> purgedObservationProperty

The purged DynamicEntityObservation.

If an observation associated with this dynamic entity was purged, this property contains the purged DynamicEntityObservation.

The default is null, meaning no observation associated with this dynamic entity was purged.

When a call to DynamicEntityDataSource.purgeAllAsync() causes multiple observations for a dynamic entity to be purged, this property is set to the last purged observation of this dynamic entity and dynamicEntityPurgedProperty() is set to true.

Since:

200.1.0

See Also:

• getPurgedObservation()
• purgedObservationProperty()

receivedObservation

public ReadOnlyObjectProperty<DynamicEntityObservation> receivedObservationProperty

The newly received DynamicEntityObservation.

When an observation associated with this dynamic entity is received from the data source, this property contains the received observation.

The default is null, meaning no observation associated with this dynamic entity was received.

Since:

200.1.0

See Also:

• getReceivedObservation()
• receivedObservationProperty()

Method Details

dynamicEntityPurgedProperty

public ReadOnlyBooleanProperty dynamicEntityPurgedProperty()

Indicates whether the DynamicEntity itself has been purged.

This flag is set when the last observation associated with this dynamic entity has been purged from the local data cache. In this case, the dynamic entity is also purged and will not be associated with any new observations received from the data source.

Purge of a dynamic entity can be caused by exceeding the limits defined by DynamicEntityDataSource.purgeOptionsProperty() or by an explicit call to DynamicEntityDataSource.purgeAllAsync().

The default is false.

Returns:

the dynamicEntityPurged property

Since:

200.1.0

See Also:

• isDynamicEntityPurged()

isDynamicEntityPurged

public boolean isDynamicEntityPurged()

Gets the value of the dynamicEntityPurged property.

Property description:

Indicates whether the DynamicEntity itself has been purged.

This flag is set when the last observation associated with this dynamic entity has been purged from the local data cache. In this case, the dynamic entity is also purged and will not be associated with any new observations received from the data source.

Purge of a dynamic entity can be caused by exceeding the limits defined by DynamicEntityDataSource.purgeOptionsProperty() or by an explicit call to DynamicEntityDataSource.purgeAllAsync().

The default is false.

Returns:

the value of the dynamicEntityPurged property

Since:

200.1.0

See Also:

• dynamicEntityPurgedProperty()

purgedObservationProperty

public ReadOnlyObjectProperty<DynamicEntityObservation> purgedObservationProperty()

The purged DynamicEntityObservation.

If an observation associated with this dynamic entity was purged, this property contains the purged DynamicEntityObservation.

The default is null, meaning no observation associated with this dynamic entity was purged.

When a call to DynamicEntityDataSource.purgeAllAsync() causes multiple observations for a dynamic entity to be purged, this property is set to the last purged observation of this dynamic entity and dynamicEntityPurgedProperty() is set to true.

Returns:

the purgedObservation property

Since:

200.1.0

See Also:

• getPurgedObservation()

getPurgedObservation

public DynamicEntityObservation getPurgedObservation()

Gets the value of the purgedObservation property.

Property description:

The purged DynamicEntityObservation.

If an observation associated with this dynamic entity was purged, this property contains the purged DynamicEntityObservation.

The default is null, meaning no observation associated with this dynamic entity was purged.

When a call to DynamicEntityDataSource.purgeAllAsync() causes multiple observations for a dynamic entity to be purged, this property is set to the last purged observation of this dynamic entity and dynamicEntityPurgedProperty() is set to true.

Returns:

the value of the purgedObservation property

Since:

200.1.0

See Also:

• purgedObservationProperty()

receivedObservationProperty

public ReadOnlyObjectProperty<DynamicEntityObservation> receivedObservationProperty()

The newly received DynamicEntityObservation.

When an observation associated with this dynamic entity is received from the data source, this property contains the received observation.

The default is null, meaning no observation associated with this dynamic entity was received.

Returns:

the receivedObservation property

Since:

200.1.0

See Also:

• getReceivedObservation()

getReceivedObservation

public DynamicEntityObservation getReceivedObservation()

Gets the value of the receivedObservation property.

Property description:

The newly received DynamicEntityObservation.

When an observation associated with this dynamic entity is received from the data source, this property contains the received observation.

The default is null, meaning no observation associated with this dynamic entity was received.

Returns:

the value of the receivedObservation property

Since:

200.1.0

See Also:

• receivedObservationProperty()