Obsolete Members for DynamicEntityDataSource

  • DynamicEntityDataSource
  • The following members of class DynamicEntityDataSource are deprecated. They are provided to keep old source code working. We strongly advise against using them in new code.

    Public Functions

    (deprecated) Esri::ArcGISRuntime::TaskWatcher connectDataSource()
    (deprecated) Esri::ArcGISRuntime::TaskWatcher disconnectDataSource()
    (deprecated) Esri::ArcGISRuntime::TaskWatcher purgeAll()

    Signals

    (deprecated) void connectDataSourceCompleted(const QUuid &taskId)
    (deprecated) void disconnectDataSourceCompleted(const QUuid &taskId)
    (deprecated) void purgeAllCompleted(const QUuid &taskId)

    Member Function Documentation

    Esri::ArcGISRuntime::TaskWatcher DynamicEntityDataSource::connectDataSource()

    This function is deprecated. We strongly advise against using it in new code.

    Connects to a service that provides dynamic entity observations.

    Data does not start streaming from the dynamic entity data source until it's loaded and connected. Once the connection is successfully established, data begins to flow from the stream.

    Use this method to explicitly connect to the data source. This call loads the data source if it is not already loaded and then initiates a persistent connection to the service that provides the observation stream. When this method completes, the connectionStatus is set to connected or failed.

    Note that a data source connection is initiated implicitly if the data source is contained by a DynamicEntityLayer and added to a map or scene.

    This method returns a TaskWatcher for the asynchronous operation.

    [signal] void DynamicEntityDataSource::connectDataSourceCompleted(const QUuid &taskId)

    This function is deprecated. We strongly advise against using it in new code.

    Signal emitted when the connectDataSource operation completes.

    • taskId - The task ID of the asynchronous operation.

    Esri::ArcGISRuntime::TaskWatcher DynamicEntityDataSource::disconnectDataSource()

    This function is deprecated. We strongly advise against using it in new code.

    Closes the connection to a service.

    Use this method to explicitly disconnect from a data source. When this method completes, the connectionStatus is set to disconnected or failed.

    If this method is called when a data source has a connectionStatus of connecting, the current connection attempt is cancelled.

    This method returns a TaskWatcher for the asynchronous operation.

    [signal] void DynamicEntityDataSource::disconnectDataSourceCompleted(const QUuid &taskId)

    This function is deprecated. We strongly advise against using it in new code.

    Signal emitted when the disconnectDataSource operation completes.

    • taskId - The task ID of the asynchronous operation.

    Esri::ArcGISRuntime::TaskWatcher DynamicEntityDataSource::purgeAll()

    This function is deprecated. We strongly advise against using it in new code.

    Removes all dynamic entity observations from the in-memory data cache as well as from the map or scene

    Sometimes, a large number of dynamic entity observations can crowd the display and make information hard to interpret. You can clear (purge) all dynamic entity observations to remove stale information and limit the amount of memory consumed. This does not unsubscribe the app from the service, so new dynamic entity observations will continue to display as they become available.

    This method returns a TaskWatcher for the asynchronous operation.

    [signal] void DynamicEntityDataSource::purgeAllCompleted(const QUuid &taskId)

    This function is deprecated. We strongly advise against using it in new code.

    Signal emitted when the purgeAll operation completes.

    • taskId - The task ID of the asynchronous operation.

    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.