TrackingStatus Class

  • TrackingStatus
  • class Esri::ArcGISRuntime::TrackingStatus

    Defines route tracking current status data. More...

    Header: #include <TrackingStatus.h>
    Since: Esri::ArcGISRuntime 100.6
    Inherits: Esri::ArcGISRuntime::Object

    Public Functions

    virtual ~TrackingStatus() override
    int currentManeuverIndex() const
    Esri::ArcGISRuntime::TrackingProgress *destinationProgress() const
    Esri::ArcGISRuntime::DestinationStatus destinationStatus() const
    Esri::ArcGISRuntime::Location displayLocation() const
    bool isApproachingFinalDestination() const
    bool isOnRoute() const
    bool isRouteCalculating() const
    Esri::ArcGISRuntime::Location locationOnRoute() const
    Esri::ArcGISRuntime::TrackingProgress *maneuverProgress() const
    int remainingDestinationCount() const
    Esri::ArcGISRuntime::TrackingProgress *routeProgress() const
    Esri::ArcGISRuntime::RouteResult routeResult() const
    QList<int> stopIndexesAtNextDestination() const

    Detailed Description

    Contains information about route tracker status. Used with the RouteTracker, this type contains a report of tracking status. It is returned from several tracking-related methods and signals to report the current tracking status.

    Relevant samples:

    • Navigate route with rerouting: Navigate between two points and dynamically recalculate an alternate route when the original route is unavailable.

    Member Function Documentation

    [override virtual] TrackingStatus::~TrackingStatus()

    Destructor.

    int TrackingStatus::currentManeuverIndex() const

    Returns the current maneuver index.

    The index of current maneuver in Route::directionManeuvers.

    Esri::ArcGISRuntime::TrackingProgress *TrackingStatus::destinationProgress() const

    Returns the tracking progress until next destination (Stop).

    Esri::ArcGISRuntime::DestinationStatus TrackingStatus::destinationStatus() const

    Returns the destination status.

    Esri::ArcGISRuntime::Location TrackingStatus::displayLocation() const

    Returns the display location.

    If current location isOnRoute = true then this will be an adjusted location (snapped to route) and bearing (smoothed). If current location isOnRoute = false then this will be the passed in GPS location, but with an adjusted bearing (smoothed). This location should be used for displaying current position on a map.

    [since Esri::ArcGISRuntime 100.9] bool TrackingStatus::isApproachingFinalDestination() const

    Returns true if the next Esri::ArcGISRuntime::Stop (or stops) are the final destination in the route.

    If there are coincident stops at the end of the route, the Esri::ArcGISRuntime::RouteTracker::isSkipCoincidentStops value determines if they are treated as single destination or not.

    This function was introduced in Esri::ArcGISRuntime 100.9.

    bool TrackingStatus::isOnRoute() const

    Returns a bool indicating whether or not the current location is on the route.

    bool TrackingStatus::isRouteCalculating() const

    Returns a bool indicating whether the route is currently being calculated.

    Esri::ArcGISRuntime::Location TrackingStatus::locationOnRoute() const

    Returns current location on route.

    Snapped to route location of last GPS location passed in to RouteTracker::trackLocationAsync(const Esri::ArcGISRuntime::Location&). If current status is isOnRoute = true this will be the same as the displayLocation. If current status is isOnRoute = false this value is not updated and last location that was on the route will be returned.

    Esri::ArcGISRuntime::TrackingProgress *TrackingStatus::maneuverProgress() const

    Returns the tracking progress along current maneuver.

    int TrackingStatus::remainingDestinationCount() const

    Returns the remaining destination count.

    The number of (routed) stops yet to be visited. This value does not include waypoints, unlocated/unrouted locations. Calling RouteTracker::switchToNextDestinationAsync will decrease value. The invalid value for remaining destination count is -1.

    See also RouteTracker::switchToNextDestinationAsync.

    Esri::ArcGISRuntime::TrackingProgress *TrackingStatus::routeProgress() const

    Returns the tracking progress along entire route.

    Esri::ArcGISRuntime::RouteResult TrackingStatus::routeResult() const

    Returns the route result presently being used by route tracker.

    If rerouting happened during tracking, this RouteResult can be different than the RouteResult originally set in the RouteTracker.

    [since Esri::ArcGISRuntime 100.9] QList<int> TrackingStatus::stopIndexesAtNextDestination() const

    Returns the Esri::ArcGISRuntime::Route::stops index values relating to the upcoming destination/arrival.

    If there are coincident stops and the Esri::ArcGISRuntime::RouteTracker::isSkipCoincidentStops = true, then this will return a list with multiple index values. When there are no coincident stops, or the Esri::ArcGISRuntime::RouteTracker::isSkipCoincidentStops = false, this will return a list with a single index value. This list can be used to relate a destination/arrival to the stops in the Esri::ArcGISRuntime::Route::stops list.

    This function was introduced in Esri::ArcGISRuntime 100.9.

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

    You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

    Your ArcGIS portal

    Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

    Your ArcGIS Location Platform dashboard

    Manage billing, monitor service usage, and access additional resources.

    Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

    Close