AGSGeoprocessingParameters Class Reference

Description

Input parameters for a geoprocessing job.

Instances of this class serve as input parameters for creating a new geoprocessing job.

See also

AGSGeoprocessingTask::createJobWithParameters: to create a geoprocessing job.

Since

100

Inheritance diagram for AGSGeoprocessingParameters:

Instance Methods
(instancetype)	- initWithExecutionType:

Class Methods
(instancetype)	+ geoprocessingParametersWithExecutionType:

Properties
AGSGeoprocessingExecutionType	executionType
NSDictionary< NSString *, AGSGeoprocessingParameter * > *	inputs
AGSSpatialReference *	outputSpatialReference
AGSSpatialReference *	processSpatialReference
BOOL	returnM
BOOL	returnZ

Method Documentation

geoprocessingParametersWithExecutionType:

+ (instancetype) geoprocessingParametersWithExecutionType:

(AGSGeoprocessingExecutionType)

executionType

Initialize a new instance of geoprocessing parameters to use as inputs for creating a new geoprocessing job.

Parameters

executionType

specifying whether the job should be submitted to the server in a manner suitable for long-running processes so that the client can close the connection to the service and then periodically check for status to decide when to retrieve results, or if the job should be executed as an asynchronous operation suitable for short-running operations where the client keeps the connection open and waits for the operation to complete.

Since

100

initWithExecutionType:

- (instancetype) initWithExecutionType:

(AGSGeoprocessingExecutionType)

executionType

Initialize a new instance of geoprocessing parameters to use as inputs for creating a new geoprocessing job.

Parameters

executionType

specifying whether the job should be submitted to the server in a manner suitable for long-running processes so that the client can close the connection to the service and then periodically check for status to decide when to retrieve results, or if the job should be executed as an asynchronous operation suitable for short-running operations where the client keeps the connection open and waits for the operation to complete.

Since

100

Property Documentation

executionType

- (AGSGeoprocessingExecutionType) executionType

readnonatomicassign

Mode specifying whether the job should be submitted to the server in a manner suitable for long-running processes so that the client can close the connection to the service and then periodically check for status to decide when to retrieve results, or if the job should be executed as an asynchronous operation suitable for short-running operations where the client keeps the connection open and waits for the operation to complete.

Since

100

inputs

- (NSDictionary<NSString*,AGSGeoprocessingParameter*>*) inputs

readwritenonatomiccopy

The collection of inputs for the job.

Since

100

outputSpatialReference

- (AGSSpatialReference*) outputSpatialReference

readwritenonatomicstrong

The spatial reference of the result geometries. If not specified, the result geometries are in the same spatial reference as the input geometries. If processSpatialReference is specified and outputSpatialReference is not specified, the result geometries will be returned in processSpatialReference.

Since

100

processSpatialReference

- (AGSSpatialReference*) processSpatialReference

readwritenonatomicstrong

The intermediate spatial reference that the geoprocessing task will use to perform geometric operations. If processSpatialReference is specified and outputSpatialReference is not specified, the result geometries will be returned in processSpatialReference.

Since

100

returnM

- (BOOL) returnM

readwritenonatomicassign

Specifies whether the result geometries should contain M (measure) values.

Since

100

returnZ

- (BOOL) returnZ

readwritenonatomicassign

Specifies whether the result geometries should contain Z (elevation) values.

Since

100