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
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 |
Method Documentation
◆ addedCostForCostAttribute:
| - (double) addedCostForCostAttribute: | (NSString *) | attributeName |
Gets the added cost attribute value for the given attribute
- Parameters
-
attributeName of 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
-
attributeName of the attribute
- Returns
- cumulative cost of the attribute
- Since
- 100
- See also
AGSRouteTaskInfo::costAttributesfor a list of attributes
◆ initWithPoint:
| - (instancetype) initWithPoint: | (AGSPoint *) | point |
Initialize the stop using the provided location
- Parameters
-
point where 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
-
addedCost for the attribute attributeName of the attribute
- Since
- 100
- See also
AGSRouteTaskInfo::costAttributesfor a list of attributes
◆ stopWithPoint:
| + (instancetype) stopWithPoint: | (AGSPoint *) | point |
Initialize the stop using the provided location
- Parameters
-
point where the stop should be located
- Returns
- A new stop
- Since
- 100
Property Documentation
◆ arrivalCurbApproach
|
readnonatomicassign |
Specifies the direction a vehicle arrives at this stop.
- Since
- 100
◆ arrivalTime
|
readnonatomicstrong |
Time of arrival at the stop.
- Since
- 100
◆ arrivalTimeShift
|
readnonatomicassign |
Time zone shift in minutes for the arrival time.
- Since
- 100
◆ 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
|
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
|
readwritenonatomicassign |
The current bearing tolerance in degrees. Valid values are 0 to 180 or NaN.
- Since
- 100
◆ departureCurbApproach
|
readnonatomicassign |
Specifies the direction a vehicle departs from the stop.
- Since
- 100
◆ departureTime
|
readnonatomicstrong |
Time of departure from the stop.
- Since
- 100
◆ departureTimeShift
|
readnonatomicassign |
Time zone shift in minutes for the departure time.
- Since
- 100
◆ distanceToNetworkLocation
|
readnonatomicassign |
The distance to the closest location on the underlying network in meters.
- Since
- 100
- See also
networkLocation
◆ geometry
|
readwritenonatomicstrong |
Location the stop should be placed.
- Since
- 100
◆ locationStatus
|
readnonatomicassign |
◆ name
|
readwritenonatomiccopy |
Name of the stop
- Since
- 100
◆ navigationLatency
|
readwritenonatomicassign |
The navigation latency in seconds.
- Since
- 100
◆ navigationSpeed
|
readwritenonatomicassign |
The navigation speed in meters per second.
- Since
- 100
◆ networkLocation
|
readwritenonatomicstrong |
The location on the underlying transportation network where the stop is located.
- Since
- 100
- See also
locationStatus
◆ routeName
|
readwritenonatomiccopy |
Name of the route to which this stop belongs. You can use this to group stops into separate routes.
- Since
- 100
◆ 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
|
readwritenonatomicassign |
Stop ID. This is a caller supplied foreign key that can be used to associate output stops with input stops.
- Since
- 100.6
◆ stopType
|
readwritenonatomicassign |
Type of stop
- Since
- 100.1
◆ 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
|
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
|
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
|
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
