AGSClosestFacilityTaskResult Class Reference


Description

The result from an AGSClosestFacilityTask operation.

Since:
1.8
Inheritance diagram for AGSClosestFacilityTaskResult:
<AGSCoding>

List of all members.

Public Member Functions

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

Properties

NSArray * closestFacilityResults
NSArray * facilities
NSArray * incidents
NSArray * messages
NSArray * pointBarriers
NSArray * polygonBarriers
NSArray * polylineBarriers

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*) closestFacilityResults [read, retain]

An array of AGSClosestFacilityResult objects containing an AGSDirectionsSet (if returnDirections is true) and a route graphic (if returnRouteGraphics is true) as well as the name of the route.

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

Facilities (points) as an array of AGSGraphic objects. These are only returned when returnFacilities is true.

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

Incidents (points) as an array of AGSGraphic objects. These are only returned when returnIncidents is true.

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

Messages as an array of AGSNAMessage objects. These are received when the solve is complete. If a closest facility cannot be solved, the message returned by the server identifies the incident that could not be solved.

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

The point barriers as an array of AGSGraphic objects. They are returned only if returnPointBarriers is true (which is not the default). If you send in the point barriers as a feature set (instead of using a data layer), you already have the barriers and might not need to request them back from the server.

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

The polygon barriers as an array of AGSGraphic objects. They are returned only if returnPolygonBarriers was set to true (which is not the default). If you send in the polygon barriers as a featureSet (instead of using DataLayer), you already have the barriers and might not need to request them back from the server.

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

The polyline barriers as an array of AGSGraphic objects. They are returned only if returnPolylineBarriers was set to true (which is not the default). If you send in the polyline barriers as a featureSet (instead of using DataLayer), you already have the barriers and might not need to request them back from the server.

Since:
1.8