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

Description

Result returned by AGSRouteTask.

Instances of this class represent the result of solveRouteWithParameters:completion: (AGSRouteTask). The result is a collection of computed routes, barriers used in the computation, and messages generated during the process.

Since
100
Inheritance diagram for AGSRouteResult:
AGSObject

Properties

NSString * directionsLanguage
 
NSArray< NSString * > * messages
 
NSArray< AGSPointBarrier * > * pointBarriers
 
NSArray< AGSPolygonBarrier * > * polygonBarriers
 
NSArray< AGSPolylineBarrier * > * polylineBarriers
 
NSArray< AGSRoute * > * routes
 

Property Documentation

◆ directionsLanguage

- (NSString*) directionsLanguage
readnonatomiccopy

The language used when computing directions. For example, en, fr, pt-BR, zh-Hans, etc. The list of languages supported is available in AGSRouteTaskInfo::supportedLanguages

Since
100
See also
AGSRouteParameters::directionsLanguage to specify which language to use

◆ messages

- (NSArray<NSString*>*) messages
readnonatomiccopy

Informational messages that were generated while computing routes.

Since
100

◆ pointBarriers

- (NSArray<AGSPointBarrier*>*) pointBarriers
readnonatomiccopy

Point barriers used in the route computation. Barriers are only returned if AGSRouteParameters::returnPointBarriers is YES.

Since
100
See also
- setPointBarriers: (AGSRouteParameters) or - setPointBarriersWithFeatureTable:queryParameters: (AGSRouteParameters) to specify the barriers to use

◆ polygonBarriers

- (NSArray<AGSPolygonBarrier*>*) polygonBarriers
readnonatomiccopy

Polygon barriers used in the route computation. Barriers are only returned if AGSRouteParameters::returnPolygonBarriers is YES.

Since
100
See also
- setPolygonBarriers: (AGSRouteParameters) or - setPolygonBarriersWithFeatureTable:queryParameters: (AGSRouteParameters) to specify the barriers to use

◆ polylineBarriers

- (NSArray<AGSPolylineBarrier*>*) polylineBarriers
readnonatomiccopy

Polyline barriers used in the route computation. Barriers are only returned if AGSRouteParameters::returnPolylineBarriers is YES.

Since
100
See also
- setPolylineBarriers: (AGSRouteParameters) or - setPolylineBarriersWithFeatureTable:queryParameters: (AGSRouteParameters) to specify the barriers to use

◆ routes

- (NSArray<AGSRoute*>*) routes
readnonatomiccopy

Each elements represents an indepdendent route with its own driving directions. Stops are grouped into diffrent routes based on AGSStop::routeName. Only available if AGSRouteParameters::returnRoutes was enabled.

See also
AGSRoute
Since
100