Class DynamicEntityDataSourcePurgeOptions
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 Summary
TypePropertyDescriptionThe maximum time (in seconds) an observation remains in the application.The maximum number of observations per track.The maximum number of observations cached by the application. -
Method Summary
Modifier and TypeMethodDescriptiondouble
Gets the value of themaximumDuration
property.long
Gets the value of themaximumObservations
property.int
Gets the value of themaximumObservationsPerTrack
property.The maximum time (in seconds) an observation remains in the application.The maximum number of observations per track.The maximum number of observations cached by the application.void
setMaximumDuration
(double maximumDuration) Sets the value of themaximumDuration
property.void
setMaximumObservations
(long maximumObservations) Sets the value of themaximumObservations
property.void
setMaximumObservationsPerTrack
(int maximumObservationsPerTrack) Sets the value of themaximumObservationsPerTrack
property.
-
Property Details
-
maximumDuration
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
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
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
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.
- Returns:
- the
maximumDuration
property - Since:
- 200.1.0
- See Also:
-
getMaximumDuration
public double getMaximumDuration()Gets the value of themaximumDuration
property.- 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.
- Returns:
- the value of the
maximumDuration
property - Since:
- 200.1.0
- See Also:
-
setMaximumDuration
public void setMaximumDuration(double maximumDuration) Sets the value of themaximumDuration
property.- 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.
- Parameters:
maximumDuration
- the value for themaximumDuration
property- Since:
- 200.1.0
- See Also:
-
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.
- Returns:
- the
maximumObservations
property - Since:
- 200.1.0
- See Also:
-
getMaximumObservations
public long getMaximumObservations()Gets the value of themaximumObservations
property.- 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.
- Returns:
- the value of the
maximumObservations
property - Since:
- 200.1.0
- See Also:
-
setMaximumObservations
public void setMaximumObservations(long maximumObservations) Sets the value of themaximumObservations
property.- 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.
- Parameters:
maximumObservations
- the value for themaximumObservations
property- Since:
- 200.1.0
- See Also:
-
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.
- Returns:
- the
maximumObservationsPerTrack
property - Since:
- 200.1.0
- See Also:
-
getMaximumObservationsPerTrack
public int getMaximumObservationsPerTrack()Gets the value of themaximumObservationsPerTrack
property.- 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.
- Returns:
- the value of the
maximumObservationsPerTrack
property - Since:
- 200.1.0
- See Also:
-
setMaximumObservationsPerTrack
public void setMaximumObservationsPerTrack(int maximumObservationsPerTrack) Sets the value of themaximumObservationsPerTrack
property.- 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.
- Parameters:
maximumObservationsPerTrack
- the value for themaximumObservationsPerTrack
property- Since:
- 200.1.0
- See Also:
-