ArcGIS Runtime SDK for iOS
100.15
|
A task to perform Geoprocessing.
Instances of this class represent a Geoprocessing Task that is used to invoke tasks on a remote ArcGIS Geoprocessing Service. Geoprocessing Services host one or more tasks that allow you to automate your GIS workflows such as spatial analysis and data management.
Instance Methods | |
(void) | - cancelLoad |
(id< AGSCancelable >) | - defaultGeoprocessingParametersWithCompletion: |
(void) | - doCancelLoading |
(void) | - doStartLoading: |
(AGSGeoprocessingJob *) | - geoprocessingJobWithParameters: |
(instancetype) | - initWithURL: |
(void) | - loadDidFinishWithError: |
(void) | - loadWithCompletion: |
(void) | - onLoadStatusChanged |
(void) | - retryLoadWithCompletion: |
Class Methods | |
(instancetype) | + geoprocessingTaskWithURL: |
Properties | |
AGSCredential * | credential |
AGSGeoprocessingTaskInfo * | geoprocessingTaskInfo |
NSError * | loadError |
AGSLoadStatus | loadStatus |
AGSRequestConfiguration * | requestConfiguration |
NSURL * | URL |
|
requiredinherited |
Cancels loading if it is in progress, otherwise it does nothing. This should be called carefully because other objects could be waiting for loadWithCompletion:
or retryLoadWithCompletion:
to complete and this will call them all back with the error of NSUserCancelledError
- (id<AGSCancelable>) defaultGeoprocessingParametersWithCompletion: | (void(^)(AGSGeoprocessingParameters *__nullable geoprocessingParams, NSError *__nullable error)) | completion |
- (void) doCancelLoading |
Never call this method directly. The framework calls this method on a background thread when cancelLoad (AGSLoadable-p)
is called. It is meant to be overriden by subclasses. Subclasses should override this method to cancel loading their data and call loadDidFinishWithError: (AGSLoadableBase(ForSubclassEyesOnly))
at the end passing in an error representing NSUserCancelledError
.
Provided by category AGSLoadableBase(ForSubclassEyesOnly).
- (void) doStartLoading: | (BOOL) | retrying |
Never call this method directly. The framework calls this method on a background thread when loadWithCompletion: (AGSLoadable-p)
or retryLoadWithCompletion: (AGSLoadable-p)
is called. It is meant to be overriden by subclasses. Subclasses should override this method to load their data and call loadDidFinishWithError: (AGSLoadableBase(ForSubclassEyesOnly))
upon completion, passing in the error if any.
retrying | flag that is true if this method was called from retryLoadWithCompletion: (AGSLoadable-p) . |
Provided by category AGSLoadableBase(ForSubclassEyesOnly).
- (AGSGeoprocessingJob*) geoprocessingJobWithParameters: | (AGSGeoprocessingParameters *) | parameters |
Returns a job which can be used to execute geoprocessing tasks The result of the job will be of type AGSGeoprocessingResult
.
startWithStatusHandler:completion: (AGSGeoprocessingJob)
parameters | specifying inputs for the geoprocessing job |
AGSGeoprocessingResult
+ (instancetype) geoprocessingTaskWithURL: | (NSURL *) | URL |
Initialize a geoprocessing task with a URL to a task on a remote ArcGIS Geoprocessing service.
URL | to a task on a remote ArcGIS Geoprocessing service. For example, http://sampleserver2.arcgisonline.com/ArcGIS/rest/services/Elevation/ESRI_Elevation_World/GPServer/ProfileService |
- (instancetype) initWithURL: | (NSURL *) | URL |
Initialize a geoprocessing task with a URL to a task on a remote ArcGIS Geoprocessing service.
URL | to a task on a remote ArcGIS Geoprocessing service. For example, http://sampleserver2.arcgisonline.com/ArcGIS/rest/services/Elevation/ESRI_Elevation_World/GPServer/ProfileService |
- (void) loadDidFinishWithError: | (nullable NSError *) | error |
Only subclasses should call this method in doStartLoading: (AGSLoadableBase(ForSubclassEyesOnly))
and doCancelLoading (AGSLoadableBase(ForSubclassEyesOnly))
when done loading or failed to load.
Provided by category AGSLoadableBase(ForSubclassEyesOnly).
|
requiredinherited |
Loads data for the object asynchronously. The completion block is invoked upon completion.
You can call this method any number of times, however only one attempt is made to load the data. If it is already loading, it will just continue to load (i.e. not force a reload). If it has already loaded successfully, the completion block will be invoked right away. If it has already failed to load, the completion block will be invoked right away with error previously encountered. This method supports multiple callers and will call them all back on completion. However, each caller's completion block will be invoked once and only once.
completion | block that is invoked when object loads successfully or fails to load. An error is passed to the block if the object fails to load. |
- cancelLoad
to cancel loading - retryLoadWithCompletion:
to force reload - (void) onLoadStatusChanged |
Never call this method directly. The framework calls this method on a background thread when AGSLoadable::loadStatus
changes is called. Subclasses can optionally implement this to know when their loading status has changed.
Provided by category AGSLoadableBase(ForSubclassEyesOnly).
|
requiredinherited |
Tries to reload when an object has failed to load. This method should be called judiciously. It should be called when:
cancelLoad
and then this methodIf the data hasn't started loading, it will start loading. If it is already loading, it will just continue to load. If it has already loaded successfully, calls back right away. If it has already failed to load, tries again. This method supports multiple callers and will call them all back on completion. However, each caller's completion block will be invoked once and only once.
completion | block that is invoked when object loads successfully or fails to load. An error is passed to the block if the object fails to load. |
|
readwritenonatomicstronginherited |
Security credentials to access the remote resource. Only applicable if the resource is secured.
|
readnonatomicstrong |
Metadata about the geoprocessing task and the inputs that the service expects.
|
readnonatomicstronginherited |
The error that was encountered during the most recent load operation. Will be nil if the operation succeeded.
|
readrequirednonatomicassigninherited |
Status of the load operation.
|
readwritenonatomicstronginherited |
The AGSRequestConfiguration object which defines the behavior and policies to use when accessing the remote resource. The default will be nil. If it is nil the [AGSRequestConfiguration globalConfiguration] will be used.
|
readrequirednonatomicstronginherited |
The URL of the remote resource.