Class DynamicEntityDataSourcePurgeOptions

java.lang.Object
com.esri.arcgisruntime.realtime.DynamicEntityDataSourcePurgeOptions

public final class DynamicEntityDataSourcePurgeOptions extends Object
Purge options for a dynamic entity data source.

Data received from a DynamicEntityDataSource is cached in memory on the client and can grow quickly depending on the number of dynamic entities and frequency of updates. Use this class and the DynamicEntityDataSource.purgeOptionsProperty() property to control app storage in the local data cache.

Properties on this object affect cached observations and should not be confused with similar options in TrackDisplayProperties which are applied on the DynamicEntityLayer and affect visibility of observations on a map or scene.

By default, the maximum total number of observations stored is 100,000 with no limit to the number of observations per track and no observation age limit.

Since:
200.1.0
  • Property Details

    • maximumDuration

      public DoubleProperty maximumDurationProperty
      The maximum time (in seconds) an observation remains in the application.

      Observations older than the specified maximum duration are removed from the local data cache.

      The default value is 0.0 seconds which means the maximum duration is disabled and duration is not used to purge observations from the local data cache. Setting maximum duration to anything else below 1.0 defaults to 1.0.

      Since:
      200.1.0
      See Also:
    • maximumObservations

      public LongProperty maximumObservationsProperty
      The maximum number of observations cached by the application.

      Use this property to limit the total number of observations cached in the local data cache without regard to the track the observations belong to.

      The default value is 100,000. A value of 0 disables the maximum observations purge option.

      Since:
      200.1.0
      See Also:
    • maximumObservationsPerTrack

      public IntegerProperty maximumObservationsPerTrackProperty
      The maximum number of observations per track.

      Use this property to limit the number of observations cached in the local data cache per unique track ID.

      The default value is 0 which means the maximum observations per track purge option is disabled.

      Since:
      200.1.0
      See Also:
  • Method Details

    • maximumDurationProperty

      public DoubleProperty maximumDurationProperty()
      The maximum time (in seconds) an observation remains in the application.

      Observations older than the specified maximum duration are removed from the local data cache.

      The default value is 0.0 seconds which means the maximum duration is disabled and duration is not used to purge observations from the local data cache. Setting maximum duration to anything else below 1.0 defaults to 1.0.

      Since:
      200.1.0
      See Also:
    • getMaximumDuration

      public double getMaximumDuration()
      Gets the value of the property maximumDuration.
      Property description:
      The maximum time (in seconds) an observation remains in the application.

      Observations older than the specified maximum duration are removed from the local data cache.

      The default value is 0.0 seconds which means the maximum duration is disabled and duration is not used to purge observations from the local data cache. Setting maximum duration to anything else below 1.0 defaults to 1.0.

      Since:
      200.1.0
    • setMaximumDuration

      public void setMaximumDuration(double maximumDuration)
      Sets the value of the property maximumDuration.
      Property description:
      The maximum time (in seconds) an observation remains in the application.

      Observations older than the specified maximum duration are removed from the local data cache.

      The default value is 0.0 seconds which means the maximum duration is disabled and duration is not used to purge observations from the local data cache. Setting maximum duration to anything else below 1.0 defaults to 1.0.

      Since:
      200.1.0
    • maximumObservationsProperty

      public LongProperty maximumObservationsProperty()
      The maximum number of observations cached by the application.

      Use this property to limit the total number of observations cached in the local data cache without regard to the track the observations belong to.

      The default value is 100,000. A value of 0 disables the maximum observations purge option.

      Since:
      200.1.0
      See Also:
    • getMaximumObservations

      public long getMaximumObservations()
      Gets the value of the property maximumObservations.
      Property description:
      The maximum number of observations cached by the application.

      Use this property to limit the total number of observations cached in the local data cache without regard to the track the observations belong to.

      The default value is 100,000. A value of 0 disables the maximum observations purge option.

      Since:
      200.1.0
    • setMaximumObservations

      public void setMaximumObservations(long maximumObservations)
      Sets the value of the property maximumObservations.
      Property description:
      The maximum number of observations cached by the application.

      Use this property to limit the total number of observations cached in the local data cache without regard to the track the observations belong to.

      The default value is 100,000. A value of 0 disables the maximum observations purge option.

      Since:
      200.1.0
    • maximumObservationsPerTrackProperty

      public IntegerProperty maximumObservationsPerTrackProperty()
      The maximum number of observations per track.

      Use this property to limit the number of observations cached in the local data cache per unique track ID.

      The default value is 0 which means the maximum observations per track purge option is disabled.

      Since:
      200.1.0
      See Also:
    • getMaximumObservationsPerTrack

      public int getMaximumObservationsPerTrack()
      Gets the value of the property maximumObservationsPerTrack.
      Property description:
      The maximum number of observations per track.

      Use this property to limit the number of observations cached in the local data cache per unique track ID.

      The default value is 0 which means the maximum observations per track purge option is disabled.

      Since:
      200.1.0
    • setMaximumObservationsPerTrack

      public void setMaximumObservationsPerTrack(int maximumObservationsPerTrack)
      Sets the value of the property maximumObservationsPerTrack.
      Property description:
      The maximum number of observations per track.

      Use this property to limit the number of observations cached in the local data cache per unique track ID.

      The default value is 0 which means the maximum observations per track purge option is disabled.

      Since:
      200.1.0