Obsolete Members for RouteTracker

RouteTracker

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

Public Functions

Signals

Member Function Documentation

RouteTracker::RouteTracker(const Esri::ArcGISRuntime::RouteResult &routeResult, int routeIndex, QObject *parent = nullptr)

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

Creates a Route Tracker using a specific route from a route result.

• routeResult - A RouteResult generated from route task solve.
• routeIndex - The integer value for which route to use in the array of RouteResult::routes. The array is zero-based.
• parent - The optional parent QObject.

An error is emitted if the Route is not found or if it lacks Route::stops and Route::directionManeuvers. This constructor will set the property isSkipCoincidentStops to true. To set this property explicitly use the constructor RouteTracker(const Esri::ArcGISRuntime::RouteResult&, int, bool, QObject*) instead.

since Esri::ArcGISRuntime 100.9

Use RouteTracker(const Esri::ArcGISRuntime::RouteResult&, int, bool, QObject*) instead.

[since Esri::ArcGISRuntime 100.11] Esri::ArcGISRuntime::TaskWatcher RouteTracker::enableRerouting(Esri::ArcGISRuntime::ReroutingParameters *parameters)

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

Enables automatic rerouting when the tracker detects an off-route status.

• parameters - A ReroutingParameters allow customizing background rerouting.

Rerouting only occurs when the current location is off-route, but on or near the transportation network edges. For example if an off-route state is detected, but the tracked location is in a parking lot, away from any transportation network edges, rerouting will not occur, and will occur only when a subsequent tracked location is on or near the transportation network edges.

Returns a TaskWatcher for the asynchronous operation.

This function was introduced in Esri::ArcGISRuntime 100.11.

[signal] void RouteTracker::enableReroutingCompleted(const QUuid &taskId)

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

Emitted when the enableRerouting asynchronous operation completes.

• taskId - The task ID of the enableRerouting operation.

Esri::ArcGISRuntime::TaskWatcher RouteTracker::switchToNextDestination()

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

Starts tracking progress to the next destination in the Route.

Use switchToNextDestination when the tracker reports a DestinationStatus::Reached status. Before calling switchToNextDestination make sure that TrackingStatus::remainingDestinationCount > 1. A value of 1 means navigation is proceeding to last destination. This method can also be called after DestinationStatus::Approaching in cases where the location cannot get near enough to the destination point for DestinationStatus::Reached (such as the center of a park or shopping center, for example).

RouteTracker::trackLocation needs to be called at least once before calling this method; otherwise an error will be thrown. RouteTracker::trackLocation is needed for getting TrackingStatus and for handling visitFirstStopOnStart.

The switchToNextDestinationCompleted signal will emit once the operation is complete.

[signal] void RouteTracker::switchToNextDestinationCompleted(const QUuid &taskId)

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

Emitted when the switchToNextDestination asynchronous operation completes.

• taskId - The task ID of the switchToNextDestination operation.

[since Esri::ArcGISRuntime 100.8] Esri::ArcGISRuntime::TaskWatcher RouteTracker::trackLocation(const Esri::ArcGISRuntime::Location &location)

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

Provides route tracking status relative to the provided location.

The location generally comes from a GPS but may also be a simulated or a manually entered Location. It must have valid values for X and Y coordinates, velocity (in meters per second), heading (in degrees), and a timestamp. When a new location is tracked the trackingStatusChanged signal will be emmited.

This method should be called each time a new position is received from the location source (usually once per second).

The trackLocationCompleted signal emits when the operation completes.

This function was introduced in Esri::ArcGISRuntime 100.8.

Esri::ArcGISRuntime::TaskWatcher RouteTracker::trackLocation(const QGeoPositionInfo &gpsLocation)

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

Provides route tracking status relative to the provided gpsLocation.

The location generally comes from a GPS but may also be a simulated or manually entered location. It must have valid values for X and Y coordinates, speed (in meters per second), course (in degrees), and a timestamp. Events fired for RouteTracker and TrackingStatus returned when completed.

Method should be called each time a new position is received from the location source (usually once per second).

The trackLocationCompleted signal emits when the operation completes.

[signal] void RouteTracker::trackLocationCompleted(const QUuid &taskId)

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

Emitted when the trackLocation asynchronous operation completes.

• taskId - The task ID of the trackLocation operation.