AGSServiceAreaTask Class Reference


Description

Instances of this class represent tasks that can compute service areas. A service area is a region that encompasses all accessible streets, that is, streets that lie within a specified impedance. For instance, the 10-minute service area for a facility includes all the streets that can be reached within 10 minutes from that facility.

A service area task needs a URL to a REST resource that represents a Service Area layer in a Network Analyst service. For example, http://sampleserver3.arcgisonline.com/ArcGIS/rest/services/Network/USA/NAServer/Service%20Area

Availability:
This feature is only available with services from ArcGIS Server 10.0 or above
See also:
Conceptual Doc: Using a Service Area Task
Sample: Service Area
Since:
1.8
Inheritance diagram for AGSServiceAreaTask:
AGSTask <AGSSecuredResource>

List of all members.

Public Member Functions

(id) - initWithURL:
(id) - initWithURL:credential:
(NSOperation *) - retrieveDefaultServiceAreaTaskParameters
(NSOperation *) - solveServiceAreaWithParameters:

Static Public Member Functions

(id) + serviceAreaTaskWithURL:
(id) + serviceAreaTaskWithURL:credential:

Properties

AGSCredentialcredential
id< AGSServiceAreaTaskDelegatedelegate
NSURL * URL

Member Function Documentation

- (id) initWithURL: (NSURL *)  url  

Initialize the task.

Parameters:
url URL to a task resource in the ArcGIS Server REST Services Directory.
Returns:
A new task object.
Since:
1.0
- (id) initWithURL: (NSURL *)  url
credential: (AGSCredential *)  cred 

Initialize the task with a URL and credential to a secured resource.

Parameters:
url URL to a task resource in the ArcGIS Server REST Services Directory.
cred AGSCredential used to access secure resource.
Returns:
A new task object.
Since:
1.0
- (NSOperation*) retrieveDefaultServiceAreaTaskParameters  

Retrieves the default service area parameters.

Returns:
NSOperation for the request.
Since:
1.8
+ (id) serviceAreaTaskWithURL: (NSURL *)  url  
Since:
1.8
+ (id) serviceAreaTaskWithURL: (NSURL *)  url
credential: (AGSCredential *)  cred 
Since:
1.8
- (NSOperation*) solveServiceAreaWithParameters: (AGSServiceAreaTaskParameters *)  serviceAreaParams  

Performs a service area operation with the given input parameters.

Parameters:
serviceAreaParams The input parameters for the service area operation.
Returns:
NSOperation for the current service area task.
Since:
1.8

Property Documentation

- (AGSCredential*) credential [read, write, copy, inherited]

The credential to be used to access secured resources.

Since:
1.0

Reimplemented from <AGSSecuredResource>.

- (id<AGSServiceAreaTaskDelegate>) delegate [read, write, assign]

Delegate to be notified when the service area operation has completed or returned an error.

Since:
1.8
- (NSURL*) URL [read, copy, inherited]

URL to a task resource in the ArcGIS Server REST Services Directory.

Since:
1.0