Description
A geoprocessing parameter for raster data.
Instances of this class represent a parameter for raster data that can be used as input to a geoprocessing job or returned as the result of the job.
- Since
- 100
Instance Methods | |
| (id< AGSCancelable >) | - downloadToFileURL:completion: |
| (instancetype) | - initWithInputFileURL: |
| (instancetype) | - initWithUploadID: |
| (instancetype) | - initWithURL: |
| (instancetype) | - initWithURL:format: |
Class Methods | |
| (instancetype) | + geoprocessingDataFile |
| (instancetype) | + geoprocessingDataFileWithInputFileURL: |
| (instancetype) | + geoprocessingDataFileWithUploadID: |
| (instancetype) | + geoprocessingDataFileWithURL: |
| (instancetype) | + geoprocessingParameter |
| (instancetype) | + geoprocessingRaster |
| (instancetype) | + geoprocessingRasterWithInputFileURL: |
| (instancetype) | + geoprocessingRasterWithUploadID: |
| (instancetype) | + geoprocessingRasterWithURL: |
| (instancetype) | + geoprocessingRasterWithURL:format: |
Properties | |
| NSString * | format |
| NSURL * | inputFileURL |
| AGSGeoprocessingParameterType | type |
| NSString * | uploadID |
| NSURL * | URL |
Method Documentation
◆ downloadToFileURL:completion:
| - (id<AGSCancelable>) downloadToFileURL: | (NSURL *) | fileURL | |
| completion: | (void(^)(NSURL *__nullable fileURL, NSError *__nullable error)) | completion | |
Download the file to the specified location on disk. Only applicable when this parameter's URL represents a remote file on a server.
- Parameters
-
fileURL location on disk to where the remote file should be downloaded. If location is a directory, the file will be given the name of the file take from the end of URL. Alternatively the location can be a destination filename within an existing directory. Note that any pre-existing file at that location with the same name will be deleted first.completion block that is invoked with the URL of where the file was downloaded to when the operation succeeds, or an error if it fails
- Since
- 100
◆ geoprocessingDataFile
| + (instancetype) geoprocessingDataFile |
◆ geoprocessingDataFileWithInputFileURL:
| + (instancetype) geoprocessingDataFileWithInputFileURL: | (NSURL *) | inputFileURL |
◆ geoprocessingDataFileWithUploadID:
| + (instancetype) geoprocessingDataFileWithUploadID: | (NSString *) | uploadID |
◆ geoprocessingDataFileWithURL:
| + (instancetype) geoprocessingDataFileWithURL: | (NSURL *) | URL |
Initialize the parameter with the given URL representing a file either on a remote server, or locally on disk. If the parameter is intended to be used as an input to a geoprocessing job, and if it is created with URL to a remote file, make sure the geoprocessing service has access to the remote location.
- Parameters
-
URL value for the parameter
- Since
- 100
◆ geoprocessingParameter
| + (instancetype) geoprocessingParameter |
- Deprecated:
- 100.9. Do not use this method, it creates an invalid and incomplete object.
◆ geoprocessingRaster
| + (instancetype) geoprocessingRaster |
◆ geoprocessingRasterWithInputFileURL:
| + (instancetype) geoprocessingRasterWithInputFileURL: | (NSURL *) | inputFileURL |
Initialize this parameter with a reference to a local raster file
- Parameters
-
inputFileURL URL to the location of the raster data file, for instance file://mydir/lake.tif
- Since
- 100.1
◆ geoprocessingRasterWithUploadID:
| + (instancetype) geoprocessingRasterWithUploadID: | (NSString *) | uploadID |
Initialize this parameter with a reference to a remote raster file that has been uploaded to the service
- Parameters
-
uploadID The upload ID of a raster uploaded to the geoprocessing service.
- Since
- 100.1
◆ geoprocessingRasterWithURL:
| + (instancetype) geoprocessingRasterWithURL: | (NSURL *) | URL |
Initialize this parameter with a reference to a remote raster file
- Parameters
-
URL to the location of the raster data file, for instance http://myserver/lake.tif
- Since
- 100
◆ geoprocessingRasterWithURL:format:
| + (instancetype) geoprocessingRasterWithURL: | (NSURL *) | URL | |
| format: | (NSString *) | format | |
Initialize this parameter with a reference to a remote raster file
- Parameters
-
URL to the location of the raster data file, for instance http://myserver/lake.tifformat of the raster data, such as "jpg", "tif", and so on.
- Since
- 100
◆ initWithInputFileURL:
| - (instancetype) initWithInputFileURL: | (NSURL *) | inputFileURL |
Initialize this parameter with a reference to a local raster file
- Parameters
-
inputFileURL URL to the location of the raster data file, for instance file://mydir/lake.tif
- Since
- 100.1
Implements AGSGeoprocessingDataFile.
◆ initWithUploadID:
| - (instancetype) initWithUploadID: | (NSString *) | uploadID |
Initialize this parameter with a reference to a remote raster file that has been uploaded to the service
- Parameters
-
uploadID The upload ID of a raster uploaded to the geoprocessing service.
- Since
- 100.1
Implements AGSGeoprocessingDataFile.
◆ initWithURL:
| - (instancetype) initWithURL: | (NSURL *) | URL |
Initialize this parameter with a reference to a remote raster file
- Parameters
-
URL to the location of the raster data file, for instance http://myserver/lake.tif
- Since
- 100
Implements AGSGeoprocessingDataFile.
◆ initWithURL:format:
| - (instancetype) initWithURL: | (NSURL *) | URL | |
| format: | (NSString *) | format | |
Initialize this parameter with a reference to a remote raster file
- Parameters
-
URL to the location of the raster data file, for instance http://myserver/lake.tifformat of the raster data, such as "jpg", "tif", and so on.
- Since
- 100
Property Documentation
◆ format
|
readwritenonatomiccopy |
Format of the raster data, such as "jpg", "tif", and so on.
- Since
- 100
◆ inputFileURL
|
readwritenonatomicstronginherited |
The input file path of this parameter. This should be the location on disk of a file that will be uploaded to the server that the geoprocessing task will run on. This is only for input parameters. Setting this will override a URL set with AGSGeoprocessingDataFile::URL. Note that this property will be ignored if AGSGeoprocessingDataFile::uploadID is set.
- Since
- 100.1
◆ type
|
readnonatomicassigninherited |
The data type of the parameter.
- Since
- 100
◆ uploadID
|
readwritenonatomiccopyinherited |
The upload item id of this parameter. This should be the item id of an item in the geoprocessing service's uploads resource. This is only for input parameters. This will be the upload id of an item previously uploaded to the server. Note that if this property is set it will cause both the AGSGeoprocessingDataFile::inputFileURL and AGSGeoprocessingDataFile::URL properties to be ignored.
- Since
- 100.1
◆ URL
|
readwritenonatomicstronginherited |
Value of the parameter representing a local or remote file
- Since
- 100
