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

Description

An individual route between stops.

Instances of this class represent an individual route between stops that is accessible from AGSRouteResult::routes

Since
100
Inheritance diagram for AGSRoute:
AGSObject

Instance Methods

(double) - costForCostAttribute:
 

Properties

NSArray< AGSDirectionManeuver * > * directionManeuvers
 
NSDate * endTime
 
double endTimeShift
 
AGSPolylinerouteGeometry
 
NSString * routeName
 
NSDate * startTime
 
double startTimeShift
 
NSArray< AGSStop * > * stops
 
double totalLength
 
double totalTime
 
double travelTime
 
double violationTime
 
double waitTime
 

Method Documentation

◆ costForCostAttribute:

- (double) costForCostAttribute: (NSString *)  attributeName

Property Documentation

◆ directionManeuvers

- (NSArray<AGSDirectionManeuver*>*) directionManeuvers
readnonatomiccopy

Turn-by-turn driving directions along this route. Only available if AGSRouteParameters::returnDirections was enabled.

See also
AGSDirectionManeuver
Since
100

◆ endTime

- (NSDate*) endTime
readnonatomicstrong

Time when the route ends (arriving at the last stop) in the current locale of the device.

Since
100

◆ endTimeShift

- (double) endTimeShift
readnonatomicassign

Time zone shift in minutes (based on the time zone of the last stop) for the end time.

Since
100

◆ routeGeometry

- (AGSPolyline*) routeGeometry
readnonatomicstrong

The route geometry.

Since
100

◆ routeName

- (NSString*) routeName
readnonatomiccopy

Name of the route. Same as AGSStop::routeName of stops included in this route.

Since
100

◆ startTime

- (NSDate*) startTime
readnonatomicstrong

Time when the route begins (departing from the first stop) in the current locale of the device.

Since
100

◆ startTimeShift

- (double) startTimeShift
readnonatomicassign

Time zone shift in minutes (based on the time zone of the last stop) for the start time.

Since
100

◆ stops

- (NSArray<AGSStop*>*) stops
readnonatomiccopy

The stops visited along this route. Only available if AGSRouteParameters::returnStops was enabled.

Note
The sequence stops are visited in the route may be different from the order they are present in the list if AGSRouteParameters::findBestSequence is enabled.
Since
100
See also
AGSStop::sequence for the sequence in which stops are visited by a route.

◆ totalLength

- (double) totalLength
readnonatomicassign

Total distance (in meters) covered by the route.

Since
100

◆ totalTime

- (double) totalTime
readnonatomicassign

Overall time (in minutes) taken by the route from start to end. This includes travelTime and waitTime.

Since
100

◆ travelTime

- (double) travelTime
readnonatomicassign

Total time (in minutes) spent travelling along the route.

Since
100

◆ violationTime

- (double) violationTime
readnonatomicassign

Total time (in munutes) that the route was late in arriving within permissible time windows for stops. Only applicable if time windows were specified for stops.

See also
AGSStop::localTimeWindowStart and AGSStop::localTimeWindowEnd for specifying time windows
Since
100

◆ waitTime

- (double) waitTime
readnonatomicassign

Total time (in minutes) spent at stops waiting for time windows to open. Only applicable if time windows were specified for stops.

Since
100
See also
AGSStop::localTimeWindowStart and AGSStop::localTimeWindowEnd for specifying time windows