Skip To Content ArcGIS for Developers Sign In Dashboard

Stop Class

(Esri::ArcGISRuntime::Stop)

A location to stop along a Route. More...

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

Public Functions

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

Detailed Description

A location to stop along a Route.

A RouteTask solves a routing problem expressed in a RouteParameters. A RouteParameters includes two or more Stops that the routing solution must visit, including the route's starting location. For example, when routing between your house and your workplace, your house is one stop and your workplace is another.

Member Function Documentation

Stop::Stop()

Default constructor.

Stop::Stop(const Point &point)

Constructor that takes in a point.

Stop::Stop(const Stop &other)

Copy constructor from other Stop.

Stop::Stop(Stop &&other)

Move constructor from other Stop.

Stop::~Stop()

Destructor.

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

Returns added cost of a given attributeName.

See also setAddedCost().

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 value of time zone shift in minutes for the arrival time.

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

Returns cumulative cost of a given attributeName.

CurbApproach Stop::curbApproach() const

Returns the curb approach for this Stop.

See also setCurbApproach().

double Stop::currentBearing() const

Returns the current bearing of this Stop.

See also setCurrentBearing().

double Stop::currentBearingTolerance() const

Returns the current bearing tolerance of this Stop.

See also setCurrentBearingTolerance().

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 value of time zone shift in minutes for the departure time.

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.

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.

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().

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.

See also setRouteName().

int Stop::sequence() const

Returns the sequence of this Stop.

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

Sets the addedCost for a given attributeName.

See also addedCost().

void Stop::setCurbApproach(CurbApproach curbApproach)

Sets the curbApproach for this Stop.

See also curbApproach().

void Stop::setCurrentBearing(double currentBearing)

Sets the currentBearing of this Stop.

Both bearing and bearing tolerance have units of degrees.

For bearing, a value of 0 or 360 means north, and 180 means south. Bearing and bearing tolerance are meant to be used together. If you only set one, then the other is ignored.

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 currentBearing() and setCurrentBearingTolerance.

void Stop::setCurrentBearingTolerance(double currentBearingTolerance)

Sets the currentBearingTolerance of this Stop.

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 currentBearingTolerance() and setCurrentBearing.

void Stop::setGeometry(const Point &point)

Sets the point geometry of where this Stop is located.

See also geometry().

void Stop::setName(const QString &name)

Sets the name of the Stop.

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 NetworkLocation &networkLocation)

Sets the networkLocation of this Stop.

See also networkLocation().

void Stop::setRouteName(const QString &routeName)

Sets the routeName 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 routeName().

void Stop::setStopId(int id)

Sets the id of this stop.

This function was introduced in Esri::ArcGISRuntime 100.6.

See also stopId().

void Stop::setStopType(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.

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

See also timeWindowEnd().

void Stop::setTimeWindowStart(const QDateTime &timeWindowStart)

Sets the timeWindowStart of this Stop in UTC time.

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

See also timeWindowStart().

int Stop::stopId() const

Returns ID of this stop.

This function was introduced in Esri::ArcGISRuntime 100.6.

See also setStopId().

StopType Stop::stopType() const

Returns type of the 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.

See also setTimeWindowEnd().

QDateTime Stop::timeWindowStart() const

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

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.

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

Assignment operator from other Stop.

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

Move operator from other Stop.


Feedback on this topic?