Describes changes to a DynamicEntity that have been sent by DynamicEntity::dynamicEntityChanged. More...
| Header: | #include <DynamicEntityChangedInfo.h> |
| Since: | Esri::ArcGISRuntime 200.1 |
| Inherits: | Esri::ArcGISRuntime::Object |
Public Functions
| virtual | ~DynamicEntityChangedInfo() override |
| bool | isDynamicEntityPurged() const |
| Esri::ArcGISRuntime::DynamicEntityObservation * | purgedObservation() const |
| Esri::ArcGISRuntime::DynamicEntityObservation * | receivedObservation() const |
Detailed Description
An object of this type is sent as an argument to the DynamicEntity::dynamicEntityChanged. 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 isDynamicEntityPurged 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.
Member Function Documentation
[override virtual] DynamicEntityChangedInfo::~DynamicEntityChangedInfo ()
Destructor.
bool DynamicEntityChangedInfo::isDynamicEntityPurged () const
Returns 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::purgeOptions or by an explicit call to DynamicEntityDataSource::purgeAllAsync.
The default is false.
Esri::ArcGISRuntime::DynamicEntityObservation *DynamicEntityChangedInfo::purgedObservation () const
Returns the purged DynamicEntityObservation.
If an observation associated with this dynamic entity was purged, this property contains the purged DynamicEntityObservation.
The default is nullptr, 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 isDynamicEntityPurged is set to true.
Esri::ArcGISRuntime::DynamicEntityObservation *DynamicEntityChangedInfo::receivedObservation () const
Returns 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 nullptr, meaning no observation associated with this dynamic entity was received.