Contains input parameters that are sent to the target geoprocessing task. More...
| Header: | #include <GeoprocessingParameters.h> |
| Since: | Esri::ArcGISRuntime 100.0 |
Public Functions
| GeoprocessingParameters() | |
| GeoprocessingParameters(Esri::ArcGISRuntime::GeoprocessingExecutionType type) | |
| GeoprocessingParameters(const Esri::ArcGISRuntime::GeoprocessingParameters &other) | |
| GeoprocessingParameters(Esri::ArcGISRuntime::GeoprocessingParameters &&other) | |
| ~GeoprocessingParameters() | |
| Esri::ArcGISRuntime::GeoprocessingExecutionType | executionType() const |
| QMap<QString, Esri::ArcGISRuntime::GeoprocessingParameter *> | inputs(QObject *parent = nullptr) const |
| bool | isReturnM() const |
| bool | isReturnZ() const |
| Esri::ArcGISRuntime::SpatialReference | outputSpatialReference() const |
| Esri::ArcGISRuntime::SpatialReference | processSpatialReference() const |
| void | setExecutionType(Esri::ArcGISRuntime::GeoprocessingExecutionType type) |
| void | setInputs(const QMap<QString, Esri::ArcGISRuntime::GeoprocessingParameter *> &inputs) |
| void | setOutputSpatialReference(const Esri::ArcGISRuntime::SpatialReference &spatialReference) |
| void | setProcessSpatialReference(const Esri::ArcGISRuntime::SpatialReference &spatialReference) |
| void | setReturnM(bool returnM) |
| void | setReturnZ(bool returnZ) |
| Esri::ArcGISRuntime::GeoprocessingParameters & | operator=(const Esri::ArcGISRuntime::GeoprocessingParameters &other) |
| Esri::ArcGISRuntime::GeoprocessingParameters & | operator=(Esri::ArcGISRuntime::GeoprocessingParameters &&other) |
Detailed Description
GeoprocessingParameters contains both input parameters and environment variables that are used in the target geoprocessing task. At a minimum all parameters that are set as required on the published task must to be provided to run the task successfully. Parameters that have default values can be overridden by providing a new value in the inputs dictionary. Optional parameters can be provided the same way.
Relevant samples:
- Analyze hotspots: Use a geoprocessing service and a set of features to identify statistically significant hot spots and cold spots.
- Local server geoprocessing: Create contour lines from local raster data using a local geoprocessing package `.gpkx` and the contour geoprocessing tool.
- Viewshed (Geoprocessing): Calculate a viewshed using a geoprocessing service, in this case showing which parts of a landscape are visible from points on mountainous terrain.
Member Function Documentation
GeoprocessingParameters::GeoprocessingParameters ()
Default constructor.
[explicit] GeoprocessingParameters::GeoprocessingParameters (Esri::ArcGISRuntime::GeoprocessingExecutionType type)
Create a geoprocessing input parameters object with the given execution type.
- type - A GeoprocessingExecutionType indicating the job execution type.
Note that the execution type needs to match the expected execution type of the geoprocessing task being run as indicated by the service's metadata.
GeoprocessingParameters::GeoprocessingParameters (const Esri::ArcGISRuntime::GeoprocessingParameters &other)
Copy constructor from other GeoprocessingParameters.
GeoprocessingParameters::GeoprocessingParameters (Esri::ArcGISRuntime::GeoprocessingParameters &&other)
Move constructor from other GeoprocessingParameters.
GeoprocessingParameters::~GeoprocessingParameters ()
Destructor
Esri::ArcGISRuntime::GeoprocessingExecutionType GeoprocessingParameters::executionType () const
Returns the execution type.
See also setExecutionType().
QMap<QString, Esri::ArcGISRuntime::GeoprocessingParameter *> GeoprocessingParameters::inputs(QObject *parent = nullptr) const
Returns the input parameters with an optional parent.
The key contains the name of the input parameter and the value contains its value.
The parent argument is a new addition in the Esri::ArcGISRuntime 100.1 release.
See also setInputs().
bool GeoprocessingParameters::isReturnM () const
Returns whether m-values are returned in the results.
bool GeoprocessingParameters::isReturnZ () const
Returns whether z-values are returned in the results.
Esri::ArcGISRuntime::SpatialReference GeoprocessingParameters::outputSpatialReference () const
Returns the output spatial reference.
See also setOutputSpatialReference().
Esri::ArcGISRuntime::SpatialReference GeoprocessingParameters::processSpatialReference () const
Returns the process spatial reference.
See also setProcessSpatialReference().
void GeoprocessingParameters::setExecutionType (Esri::ArcGISRuntime::GeoprocessingExecutionType type)
Sets the execution type to type.
See also executionType().
void GeoprocessingParameters::setInputs (const QMap<QString, Esri::ArcGISRuntime::GeoprocessingParameter *> &inputs)
Sets the input parameters to inputs.
The key contains the name of the input parameter and the value contains its value.
See also inputs().
void GeoprocessingParameters::setOutputSpatialReference (const Esri::ArcGISRuntime::SpatialReference &spatialReference )
Sets the output spatial reference to spatialReference.
If processSpatialReference is set but outputSpatialReference is not, the outputs are returned in the spatial reference set in processSpatialReference.
See also outputSpatialReference().
void GeoprocessingParameters::setProcessSpatialReference (const Esri::ArcGISRuntime::SpatialReference &spatialReference )
Sets the process spatial reference to spatialReference.
If processSpatialReference is set but outputSpatialReference is not, the outputs are returned in the spatial reference set in processSpatialReference.
See also processSpatialReference().
void GeoprocessingParameters::setReturnM (bool returnM )
Sets whether m-values are returned in the results to returnM.
See also isReturnM().
void GeoprocessingParameters::setReturnZ (bool returnZ )
Sets whether z-values are returned in the results to returnZ.
See also isReturnZ().
Esri::ArcGISRuntime::GeoprocessingParameters &GeoprocessingParameters::operator=(const Esri::ArcGISRuntime::GeoprocessingParameters &other)
Assignment operator from other GeoprocessingParameters.
Esri::ArcGISRuntime::GeoprocessingParameters &GeoprocessingParameters::operator=(Esri::ArcGISRuntime::GeoprocessingParameters &&other)
Move operator from other GeoprocessingParameters.