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 Details

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

      Since:
      200.1.0
      See Also:
    • isDynamicEntityPurged

      public boolean isDynamicEntityPurged()
      Gets the value of the property dynamicEntityPurged.
      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.

      Since:
      200.1.0
    • 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.

      Since:
      200.1.0
      See Also:
    • getPurgedObservation

      public DynamicEntityObservation getPurgedObservation()
      Gets the value of the property purgedObservation.
      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.

      Since:
      200.1.0
    • 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.

      Since:
      200.1.0
      See Also:
    • getReceivedObservation

      public DynamicEntityObservation getReceivedObservation()
      Gets the value of the property receivedObservation.
      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.

      Since:
      200.1.0