ArcGIS Runtime SDK for iOS: AGSStop Class Reference
ArcGIS Runtime SDK for iOS  100.12
AGSStop Class Reference

Description

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

Instances of this class contains location inputs for the AGSRouteTask. The AGSRouteTask will create a route between two or more Stops. An AGSStop object is not an arbitrary bag of properties, but contains only the properties needed for routing (for example, a stop does not have address information).

Stops are part of AGSRouteParameters which is used as input to solveRouteWithParameters:completion: (AGSRouteTask).

You need atleast two stops to compute a route, although you can have more.

Since
100
Inheritance diagram for AGSStop:
AGSObject

Instance Methods

(double) - addedCostForCostAttribute:
 
(double) - cumulativeCostForCostAttribute:
 
(instancetype) - initWithPoint:
 
(void) - setAddedCost:forCostAttribute:
 

Class Methods

(instancetype) + stopWithPoint:
 

Properties

AGSCurbApproach arrivalCurbApproach
 
NSDate * arrivalTime
 
double arrivalTimeShift
 
AGSCurbApproach curbApproach
 
double currentBearing
 
double currentBearingTolerance
 
AGSCurbApproach departureCurbApproach
 
NSDate * departureTime
 
double departureTimeShift
 
double distanceToNetworkLocation
 
AGSPointgeometry
 
AGSLocationStatus locationStatus
 
NSString * name
 
double navigationLatency
 
double navigationSpeed
 
AGSNetworkLocationnetworkLocation
 
NSString * routeName
 
NSInteger sequence
 
NSInteger stopID
 
AGSStopType stopType
 
NSDate * timeWindowEnd
 
NSDate * timeWindowStart
 
double violationTime
 
double waitTime
 

Method Documentation

◆ addedCostForCostAttribute:

- (double) addedCostForCostAttribute: (NSString *)  attributeName

Gets the added cost attribute value for the given attribute

Parameters
attributeNameof the attribute
Returns
added cost of the attribute
Since
100

◆ cumulativeCostForCostAttribute:

- (double) cumulativeCostForCostAttribute: (NSString *)  attributeName

Gets the cumulative cost attribute value for the given attribute

Parameters
attributeNameof the attribute
Returns
cumulative cost of the attribute
Since
100
See also
AGSRouteTaskInfo::costAttributes for a list of attributes

◆ initWithPoint:

- (instancetype) initWithPoint: (AGSPoint *)  point

Initialize the stop using the provided location

Parameters
pointwhere the stop should be located
Returns
A new stop
Since
100

◆ setAddedCost:forCostAttribute:

- (void) setAddedCost: (double)  addedCost
forCostAttribute: (NSString *)  attributeName 

Sets the added cost attribute value for the given attribute

Parameters
addedCostfor the attribute
attributeNameof the attribute
Since
100
See also
AGSRouteTaskInfo::costAttributes for a list of attributes

◆ stopWithPoint:

+ (instancetype) stopWithPoint: (AGSPoint *)  point

Initialize the stop using the provided location

Parameters
pointwhere the stop should be located
Returns
A new stop
Since
100

Property Documentation

◆ arrivalCurbApproach

- (AGSCurbApproach) arrivalCurbApproach
readnonatomicassign

Specifies the direction a vehicle arrives at this stop.

Since
100

◆ arrivalTime

- (NSDate*) arrivalTime
readnonatomicstrong

Time of arrival at the stop.

Since
100

◆ arrivalTimeShift

- (double) arrivalTimeShift
readnonatomicassign

Time zone shift in minutes for the arrival time.

Since
100

◆ curbApproach

- (AGSCurbApproach) curbApproach
readwritenonatomicassign

Specifies the direction a vehicle may arrive at or depart from the stop. For example, a school bus must approach and depart a school from its door side so that students entering/exiting the bus will not have to cross the street.

Since
100

◆ currentBearing

- (double) currentBearing
readwritenonatomicassign

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

Since
100

◆ currentBearingTolerance

- (double) currentBearingTolerance
readwritenonatomicassign

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

Since
100

◆ departureCurbApproach

- (AGSCurbApproach) departureCurbApproach
readnonatomicassign

Specifies the direction a vehicle departs from the stop.

Since
100

◆ departureTime

- (NSDate*) departureTime
readnonatomicstrong

Time of departure from the stop.

Since
100

◆ departureTimeShift

- (double) departureTimeShift
readnonatomicassign

Time zone shift in minutes for the departure time.

Since
100

◆ distanceToNetworkLocation

- (double) distanceToNetworkLocation
readnonatomicassign

The distance to the closest location on the underlying network in meters.

Since
100
See also
networkLocation

◆ geometry

- (AGSPoint*) geometry
readwritenonatomicstrong

Location the stop should be placed.

Since
100

◆ locationStatus

- (AGSLocationStatus) locationStatus
readnonatomicassign

The status of the stop's location on the underlying network.

Since
100
See also
networkLocation

◆ name

- (NSString*) name
readwritenonatomiccopy

Name of the stop

Since
100

◆ navigationLatency

- (double) navigationLatency
readwritenonatomicassign

The navigation latency in seconds.

Since
100

◆ navigationSpeed

- (double) navigationSpeed
readwritenonatomicassign

The navigation speed in meters per second.

Since
100

◆ networkLocation

- (AGSNetworkLocation*) networkLocation
readwritenonatomicstrong

The location on the underlying transportation network where the stop is located.

Since
100
See also
locationStatus

◆ routeName

- (NSString*) routeName
readwritenonatomiccopy

Name of the route to which this stop belongs. You can use this to group stops into separate routes.

Since
100

◆ sequence

- (NSInteger) sequence
readnonatomicassign

The order in which stop is visited along the route. A value of 1 implies it is the first stop, and so on.

Since
100

◆ stopID

- (NSInteger) stopID
readwritenonatomicassign

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

See also
- setStopsWithFeatureTable:queryParameters: (AGSRouteParameters), AGSRoute::stops
Since
100.6

◆ stopType

- (AGSStopType) stopType
readwritenonatomicassign

Type of stop

Since
100.1

◆ timeWindowEnd

- (NSDate*) timeWindowEnd
readwritenonatomicstrong

The ending time of a permissible time window for the stop. The route will attempt to visit the stop only within its time window, if possible. Can be nil if you don't want to specify a time window constraint.

Since
100
See also
#localTimeWindowStart

◆ timeWindowStart

- (NSDate*) timeWindowStart
readwritenonatomicstrong

The begining time of a permissible time window for the stop. The route will attempt to visit the stop only within its time window, if possible. Can be nil if you don't want to specify a time window constraint.

Since
100
See also
#localTimeWindowEnd

◆ violationTime

- (double) violationTime
readnonatomicassign

The time (in minutes) by which the route arrives later than the permissible time window for the stop. This is the difference between #localArrivalTime and #localTimeWindowEnd

Since
100

◆ waitTime

- (double) waitTime
readnonatomicassign

The time (in minutes) spent at the stop waiting for the time window to open when the route arrives early This is the difference between #localArrivalTime and #localTimeWindowStart

Since
100