AGSRouteTaskResult Class Reference


Description

Instances of this class represent a result of a single AGSRouteTask solve operation. The result is a collection of computed routes, barriers used in the analysis, and messages generated during the analysis.

Since:
1.8
Inheritance diagram for AGSRouteTaskResult:
<AGSCoding>

List of all members.

Public Member Functions

(void) - decodeWithJSON:
(NSDictionary *) - encodeToJSON
(id) - initWithJSON:

Properties

NSArray * messages
NSArray * pointBarriers
NSArray * polygonBarriers
NSArray * polylineBarriers
NSArray * routeResults

Member Function Documentation

- (void) decodeWithJSON: (NSDictionary *)  json   [optional, inherited]

Decode object from JSON representation.

Parameters:
json The JSON representation of the object to be decoded.
Since:
1.0
- (NSDictionary *) encodeToJSON   [optional, inherited]

Encode and return JSON representation for object.

Returns:
JSON representation of object.
Since:
1.0
- (id) initWithJSON: (NSDictionary *)  json   [optional, inherited]

Initialize and return object from JSON representation.

Parameters:
json The JSON representation of the object to be created.
Returns:
Object decoded from JSON representation.
Since:
1.0

Property Documentation

- (NSArray*) messages [read, retain]

Messages received when solve is completed. If a route cannot be solved, the message returned by the server identifies the route that could not be solved. This is an array of AGSNAMessage objects.

Since:
1.8
- (NSArray*) pointBarriers [read, retain]

Array of AGSGraphic objects representing the point barriers. Barriers are only returned if the returnPointBarriers parameter of AGSRouteTaskParameters is true.

Since:
1.8
- (NSArray*) polygonBarriers [read, retain]

Array of AGSGraphic objects representing the polygon barriers. Barriers are only returned if the returnPolygonBarriers parameter of AGSRouteTaskParameters is true.

Since:
1.8
- (NSArray*) polylineBarriers [read, retain]

Array of AGSGraphic objects representing the polyline barriers. Barriers are only returned if the returnPolylineBarriers parameter of AGSRouteTaskParameters is true.

Since:
1.8
- (NSArray*) routeResults [read, retain]

Array of AGSRouteResult objects. Each object represents a separate route with independent driving directions. See routeName property of AGSRouteTaskParameters to see how to group stops into separate routes.

Since:
1.8