Obsolete Members for RouteTask

RouteTask

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

Public Functions

Signals

Static Public Members

Member Function Documentation

Esri::ArcGISRuntime::TaskWatcher RouteTask::createDefaultParameters()

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

Creates default route parameters from the service or database.

The createDefaultParametersCompleted signal will emit once the operation is complete, giving access to the resulting RouteParameters.

[signal] void RouteTask::createDefaultParametersCompleted(const QUuid &taskId, const Esri::ArcGISRuntime::RouteParameters &defaultParameters)

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

Signal emitted after the createDefaultParameters asynchronous method completes.

• taskId - The task ID of the asynchronous task.
• defaultParameters - The generated default RouteParameters.

[since Esri::ArcGISRuntime 100.1] Esri::ArcGISRuntime::TaskWatcher RouteTask::createParameters(const Esri::ArcGISRuntime::FeatureCollection &featureCollection)

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

Creates the route parameters from a feature collection for this route task.

Imported route parameters from a feature collection will be adjusted to the current RouteTask.

Please note:

• If travel mode obtained from featureCollection cannot be applied to current RouteTask, then it will be null.
• In cases where travel mode is null, the client can override it with another travel mode, such as one obtained from RouteTaskInfo::travelModes().
• Accumulate attributes from the route info table are applied only if they exist in RouteTaskInfo::restrictionAttributes() and RouteTaskInfo::costAttributes() for the current RouteTask.

featureCollection must contain at least a Stops table.

The createParametersCompleted signal emits when the operation is complete, giving access to the resulting RouteParameters.

This function was introduced in Esri::ArcGISRuntime 100.1.

[signal] void RouteTask::createParametersCompleted(const QUuid &taskId, const Esri::ArcGISRuntime::RouteParameters &parameters)

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

Signal emitted after the createParameters asynchronous method completes.

• taskId - The task ID of the asynchronous task.
• parameters - The generated RouteParameters.

[since Esri::ArcGISRuntime 100.3] Esri::ArcGISRuntime::TaskWatcher RouteTask::createParametersWithPortalItem(Esri::ArcGISRuntime::PortalItem *portalItem)

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

Creates the route parameters from a portal item for this route task.

This operation allows the user to download a set of route parameters stored in the portal and use them to solve routing problems locally on the device. Imported route parameters from the portal item will be adjusted to the current RouteTask.

• portalItem - The portal item object with a feature collection that contains stops, route info, and barriers tables. A stops table is required.

Please note:

• If travel mode obtained from portalItem cannot be applied to current RouteTask, then it will be null.
• In cases where travel mode is null, the client can override it with another travel mode, such as one obtained from RouteTaskInfo::travelModes().
• Accumulate attributes from the route info table are applied only if they exist in RouteTaskInfo::restrictionAttributes() and RouteTaskInfo::costAttributes() for the current RouteTask.

This function was introduced in Esri::ArcGISRuntime 100.3.

[signal, since Esri::ArcGISRuntime 100.3] void RouteTask::createParametersWithPortalItemCompleted(const QUuid &taskId, const Esri::ArcGISRuntime::RouteParameters &parameters)

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

Signal emitted after the createParametersWithPortalItem asynchronous method completes.

• taskId - The task ID of the asynchronous task.
• parameters - The generated RouteParameters.

This function was introduced in Esri::ArcGISRuntime 100.3.

[static, since Esri::ArcGISRuntime 100.3] Esri::ArcGISRuntime::TaskWatcher RouteTask::createRouteResult(Esri::ArcGISRuntime::PortalItem *portalItem)

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

Imports a pre-generated route result from the supplied portal item.

This operation allows the user to download an existing route result from a portal and use it for routing purposes on the local device.

• portalItem - The portal item with a feature collection that contains directions, stops, route info, and barriers tables.

This method returns a TaskWatcher for the asynchronous operation. Connect to the RouteTask singleton provided by the instance() method to determine when the operation is completed.

This function was introduced in Esri::ArcGISRuntime 100.3.

[signal, since Esri::ArcGISRuntime 100.3] void RouteTask::createRouteResultCompleted(const QUuid &taskId, const Esri::ArcGISRuntime::RouteResult &routeResult)

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

Signal emitted after the createRouteResult asynchronous method completes.

• taskId - The task ID of the asynchronous task.
• routeResult - The generated RouteResult.

This function was introduced in Esri::ArcGISRuntime 100.3.

[static, since Esri::ArcGISRuntime 100.3] Esri::ArcGISRuntime::RouteTask *RouteTask::instance()

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

Returns an instance of the RouteTask singleton.

The instance is used to connect to the Object::errorOccurred and createRouteResultCompleted signals. You do not need to obtain the instance to call the static methods on the RouteTask.

This function was introduced in Esri::ArcGISRuntime 100.3.

Esri::ArcGISRuntime::TaskWatcher RouteTask::solveRoute(const Esri::ArcGISRuntime::RouteParameters &routeParameters)

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

Solves a route with the given routeParameters.

The solveRouteCompleted signal will emit once the operation is complete, giving access to the RouteResult.

[signal] void RouteTask::solveRouteCompleted(const QUuid &taskId, const Esri::ArcGISRuntime::RouteResult &routeResult)

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

Signal emitted after the solveRoute asynchronous method completes.

• taskId - The task ID of the asynchronous task.
• routeResult - The generated RouteResult.