Stop Class

  • Stop
  • class Esri::ArcGISRuntime::Stop

    A class that represents a location to be visited along a route. More...

    Header: #include <Stop.h>
    Since: Esri::ArcGISRuntime 100.0

    Public Functions

    Stop(const Esri::ArcGISRuntime::Point &point)
    Stop(const Esri::ArcGISRuntime::Stop &other)
    Stop(Esri::ArcGISRuntime::Stop &&other)
    double addedCost(const QString &attributeName) const
    Esri::ArcGISRuntime::CurbApproach arrivalCurbApproach() const
    QDateTime arrivalTime() const
    double arrivalTimeShift() const
    Esri::ArcGISRuntime::Stop clone() const
    double cumulativeCost(const QString &attributeName) const
    Esri::ArcGISRuntime::CurbApproach curbApproach() const
    double currentBearing() const
    double currentBearingTolerance() const
    Esri::ArcGISRuntime::CurbApproach departureCurbApproach() const
    QDateTime departureTime() const
    double departureTimeShift() const
    double distanceToNetworkLocation() const
    Esri::ArcGISRuntime::Point geometry() const
    bool isEmpty() const
    Esri::ArcGISRuntime::LocationStatus locationStatus() const
    QString name() const
    double navigationLatency() const
    double navigationSpeed() const
    Esri::ArcGISRuntime::NetworkLocation networkLocation() const
    QString routeName() const
    int sequence() const
    void setAddedCost(const QString &attributeName, double addedCost)
    void setCurbApproach(Esri::ArcGISRuntime::CurbApproach curbApproach)
    void setCurrentBearing(double currentBearing)
    void setCurrentBearingTolerance(double currentBearingTolerance)
    void setGeometry(const Esri::ArcGISRuntime::Point &point)
    void setName(const QString &name)
    void setNavigationLatency(double navigationLatency)
    void setNavigationSpeed(double navigationSpeed)
    void setNetworkLocation(const Esri::ArcGISRuntime::NetworkLocation &networkLocation)
    void setRouteName(const QString &routeName)
    void setStopId(int id)
    void setStopType(Esri::ArcGISRuntime::StopType stopType)
    void setTimeWindowEnd(const QDateTime &timeWindowEnd)
    void setTimeWindowStart(const QDateTime &timeWindowStart)
    int stopId() const
    Esri::ArcGISRuntime::StopType stopType() const
    QDateTime timeWindowEnd() const
    QDateTime timeWindowStart() const
    double violationTime() const
    double waitTime() const
    Esri::ArcGISRuntime::Stop &operator=(const Esri::ArcGISRuntime::Stop &other)
    Esri::ArcGISRuntime::Stop &operator=(Esri::ArcGISRuntime::Stop &&other)

    Detailed Description

    The Stop class contains location inputs for the Route_task. The Route_task will create a route between two or more Stops. A Stop object is not an arbitrary bag of properties, but contains only the properties needed for routing (for example, a Stop object does not have address information). Stop objects are collected into a QList by value, and passed as an input to RouteTask.

    The stop class is derived from the graphic class.

    See also RouteTask.

    Member Function Documentation


    Default constructor.

    [explicit] Stop::Stop(const Esri::ArcGISRuntime::Point &point)

    Creates a stop instance with point.

    • point - A point.

    Creates a stop.

    Stop::Stop(const Esri::ArcGISRuntime::Stop &other)

    Copy constructor from other Stop.

    Stop::Stop(Esri::ArcGISRuntime::Stop &&other)

    Move constructor from other Stop.



    double Stop::addedCost(const QString &attributeName) const

    Returns the added cost attribute value.

    • attributeName - The name of the cost attribute.

    In case when attribute's name can not be found 0.0 will be returned.

    See also setAddedCost().

    Esri::ArcGISRuntime::CurbApproach Stop::arrivalCurbApproach() const

    Returns the arrival curb approach for this Stop.

    QDateTime Stop::arrivalTime() const

    Returns the arrival time of this Stop in UTC time.

    double Stop::arrivalTimeShift() const

    Returns the time zone shift for arrival time, in minutes.

    [since Esri::ArcGISRuntime 200.1] Esri::ArcGISRuntime::Stop Stop::clone() const

    Clones the Stop.

    This function was introduced in Esri::ArcGISRuntime 200.1.

    double Stop::cumulativeCost(const QString &attributeName) const

    Returns the cumulative cost attribute value.

    • attributeName - The name of cumulative attribute.

    In case when attribute's name can not be found 0.0 will be returned.

    Esri::ArcGISRuntime::CurbApproach Stop::curbApproach() const

    Returns the curb approach for this Stop.

    See also setCurbApproach().

    double Stop::currentBearing() const

    Returns the current bearing in degrees.

    Current bearing in degrees, measured clockwise from True-North. Typical values are 0 to 360 or NaN. Negative values are subtracted from 360 (e.g. -15 => 345). Values greater than 360 have 360 subtracted from them (e.g. 385 => 25). For this property to be used, the bearing tolerance also has to be set.

    Bearing and bearing tolerance help to disambiguate how to locate stops. For example, if you are driving on a freeway overpass and you need to reroute, then you would pass in your device compass bearing and a tolerance (say 45 degrees). This information is used to filter out streets that are potentially closer to your device x,y but are heading in the wrong direction (e.g. An underpass street might be closer to the x,y of your device but it is heading in the wrong direction and would be filtered out).

    See also setCurrentBearing().

    double Stop::currentBearingTolerance() const

    Returns the current bearing tolerance in degrees. Valid values are 0 to 180 or NaN.

    Bearing and bearing tolerance are meant to be used together. If you only set one, then the other is ignored. Bearing tolerance units are in degrees. Bearing tolerance is plus or minus the currentBearing provided. For example, you could set the currentBearing to 360, to locate streets to the north, and provide a currentBearingTolerance of 45, to find streets plus or minus 45 degrees from north.

    See also setCurrentBearingTolerance().

    Esri::ArcGISRuntime::CurbApproach Stop::departureCurbApproach() const

    Returns the departure curb approach for this Stop.

    QDateTime Stop::departureTime() const

    Returns the departure time of this Stop in UTC time.

    double Stop::departureTimeShift() const

    Returns the time zone shift for departure time, in minutes.

    double Stop::distanceToNetworkLocation() const

    Returns the distance in meters of this Stop along a network path.

    Returns NaN if the stop has not been located.

    Esri::ArcGISRuntime::Point Stop::geometry() const

    Returns the Point geometry of where this Stop is located.

    See also setGeometry().

    bool Stop::isEmpty() const

    Returns true if this Stop is empty.

    Esri::ArcGISRuntime::LocationStatus Stop::locationStatus() const

    Returns the LocationStatus of this Stop.

    QString Stop::name() const

    Returns the name of the Stop.

    See also setName().

    Returns the navigation latency in seconds.

    See also setNavigationLatency().

    Returns the navigation speed in meters-per-second.

    See also setNavigationSpeed().

    Esri::ArcGISRuntime::NetworkLocation Stop::networkLocation() const

    Returns the network location of this Stop.

    See also setNetworkLocation().

    QString Stop::routeName() const

    Returns the name of the Route to which the stop belongs.

    For example, if you want to find two distinct routes— a route with 4 stops and another with 6 stops— set the name to "Route1" for each of the four stops and "Route2" for each of the 6 stops.

    See also setRouteName().

    int Stop::sequence() const

    Returns the sequence of this Stop.

    void Stop::setAddedCost(const QString &attributeName, double addedCost)

    Sets added cost.

    • attributeName - The attribute name.
    • addedCost - The added cost.

    See also addedCost.

    void Stop::setCurbApproach(Esri::ArcGISRuntime::CurbApproach curbApproach)

    Sets the curbApproach for this Stop.

    See also curbApproach().

    void Stop::setCurrentBearing(double currentBearing)

    Sets the currentBearing to currentBearing.

    See also currentBearing.

    void Stop::setCurrentBearingTolerance(double currentBearingTolerance)

    Sets the currentBearingTolerance to currentBearingTolerance.

    See also currentBearingTolerance.

    void Stop::setGeometry(const Esri::ArcGISRuntime::Point &point)

    Sets the geometry to point.

    See also geometry.

    void Stop::setName(const QString &name)

    Sets the stop name.

    See also name.

    void Stop::setNavigationLatency(double navigationLatency)

    Sets the navigationLatency in seconds.

    See also navigationLatency.

    void Stop::setNavigationSpeed(double navigationSpeed)

    Sets the navigationSpeed in meters-per-second.

    See also navigationSpeed.

    void Stop::setNetworkLocation(const Esri::ArcGISRuntime::NetworkLocation &networkLocation)

    Sets the networkLocation to networkLocation.

    See also networkLocation.

    void Stop::setRouteName(const QString &routeName)

    Sets the routeName to routeName.

    See also routeName.

    [since Esri::ArcGISRuntime 100.6] void Stop::setStopId(int id)

    Sets the id of this stop.

    This function was introduced in Esri::ArcGISRuntime 100.6.

    See also stopId.

    [since Esri::ArcGISRuntime 100.1] void Stop::setStopType(Esri::ArcGISRuntime::StopType stopType)

    Sets the type of the stop to stopType.

    This function was introduced in Esri::ArcGISRuntime 100.1.

    See also stopType.

    void Stop::setTimeWindowEnd(const QDateTime &timeWindowEnd)

    Sets the timeWindowEnd of this Stop in UTC time.

    See also timeWindowEnd.

    void Stop::setTimeWindowStart(const QDateTime &timeWindowStart)

    Sets the timeWindowStart of this Stop in UTC time.

    See also timeWindowStart.

    [since Esri::ArcGISRuntime 100.6] int Stop::stopId() const

    Returns the stop ID.

    This is a caller supplied foreign key that can be used to associate output stops with input stops.

    {RouteParameters::setStopsWithFeatureTable(Esri::ArcGISRuntime::ArcGISFeatureTable*, const Esri::ArcGISRuntime::QueryParameters&)}, {Esri::ArcGISRuntime::Route::stops} {Route::stops}

    This function was introduced in Esri::ArcGISRuntime 100.6.

    See also setStopId() and Esri::ArcGISRuntime::RouteParameters::setStopsWithFeatureTable(Esri::ArcGISRuntime::ArcGISFeatureTable*, const Esri::ArcGISRuntime::QueryParameters&).

    [since Esri::ArcGISRuntime 100.1] Esri::ArcGISRuntime::StopType Stop::stopType() const

    Returns the type of the stop.

    Default value that will be returned on error is StopType::Stop.

    This function was introduced in Esri::ArcGISRuntime 100.1.

    See also setStopType().

    QDateTime Stop::timeWindowEnd() const

    Returns the end of the time window of this Stop in UTC time.

    This is the latest time that the Stop can be visited.

    See also setTimeWindowEnd().

    QDateTime Stop::timeWindowStart() const

    Returns the start of the time window of this Stop in UTC time.

    This is the earliest time that the Stop can be visited.

    See also setTimeWindowStart().

    double Stop::violationTime() const

    Returns the violation time of this Stop in minutes.

    double Stop::waitTime() const

    Returns the wait time of this Stop in minutes.

    Esri::ArcGISRuntime::Stop &Stop::operator=(const Esri::ArcGISRuntime::Stop &other)

    Assignment operator from other Stop.

    Esri::ArcGISRuntime::Stop &Stop::operator=(Esri::ArcGISRuntime::Stop &&other)

    Move operator from other Stop.

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