ArcGIS Runtime SDK for iOS
100.15
|
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.
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 |
AGSPoint * | geometry |
AGSLocationStatus | locationStatus |
NSString * | name |
double | navigationLatency |
double | navigationSpeed |
AGSNetworkLocation * | networkLocation |
NSString * | routeName |
NSInteger | sequence |
NSInteger | stopID |
AGSStopType | stopType |
NSDate * | timeWindowEnd |
NSDate * | timeWindowStart |
double | violationTime |
double | waitTime |
- (double) addedCostForCostAttribute: | (NSString *) | attributeName |
Gets the added cost attribute value for the given attribute
attributeName | of the attribute |
- (double) cumulativeCostForCostAttribute: | (NSString *) | attributeName |
Gets the cumulative cost attribute value for the given attribute
attributeName | of the attribute |
AGSRouteTaskInfo::costAttributes
for a list of attributes - (instancetype) initWithPoint: | (AGSPoint *) | point |
Initialize the stop using the provided location
point | where the stop should be located |
- (void) setAddedCost: | (double) | addedCost | |
forCostAttribute: | (NSString *) | attributeName | |
Sets the added cost attribute value for the given attribute
addedCost | for the attribute |
attributeName | of the attribute |
AGSRouteTaskInfo::costAttributes
for a list of attributes + (instancetype) stopWithPoint: | (AGSPoint *) | point |
Initialize the stop using the provided location
point | where the stop should be located |
|
readnonatomicassign |
Specifies the direction a vehicle arrives at this stop.
|
readnonatomicstrong |
Time of arrival at the stop.
|
readnonatomicassign |
Time zone shift in minutes for the arrival time.
|
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.
|
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.
|
readwritenonatomicassign |
The current bearing tolerance in degrees. Valid values are 0 to 180 or NaN.
|
readnonatomicassign |
Specifies the direction a vehicle departs from the stop.
|
readnonatomicstrong |
Time of departure from the stop.
|
readnonatomicassign |
Time zone shift in minutes for the departure time.
|
readnonatomicassign |
The distance to the closest location on the underlying network in meters.
networkLocation
|
readwritenonatomicstrong |
Location the stop should be placed.
|
readnonatomicassign |
|
readwritenonatomiccopy |
Name of the stop
|
readwritenonatomicassign |
The navigation latency in seconds.
|
readwritenonatomicassign |
The navigation speed in meters per second.
|
readwritenonatomicstrong |
The location on the underlying transportation network where the stop is located.
locationStatus
|
readwritenonatomiccopy |
Name of the route to which this stop belongs. You can use this to group stops into separate routes.
|
readnonatomicassign |
The order in which stop is visited along the route. A value of 1 implies it is the first stop, and so on.
|
readwritenonatomicassign |
Stop ID. This is a caller supplied foreign key that can be used to associate output stops with input stops.
|
readwritenonatomicassign |
Type of stop
|
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.
#localTimeWindowStart
|
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.
#localTimeWindowEnd
|
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
|
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