Skip To Content ArcGIS for Developers Sign In Dashboard

GeoprocessingParameters Class

(Esri::ArcGISRuntime::GeoprocessingParameters)

Contains input parameters that are sent to the target geoprocessing task. More...

Header: #include <GeoprocessingParameters>
Since: Esri::ArcGISRuntime 100.0

Public Functions

GeoprocessingParameters()
GeoprocessingParameters(GeoprocessingExecutionType type)
GeoprocessingParameters(const GeoprocessingParameters &other)
GeoprocessingParameters(GeoprocessingParameters &&other)
~GeoprocessingParameters()
GeoprocessingExecutionType executionType() const
QMap<QString, GeoprocessingParameter *> inputs(QObject *parent = nullptr) const
bool isReturnM() const
bool isReturnZ() const
SpatialReference outputSpatialReference() const
SpatialReference processSpatialReference() const
void setExecutionType(GeoprocessingExecutionType type)
void setInputs(const QMap<QString, GeoprocessingParameter *> &inputs)
void setOutputSpatialReference(const SpatialReference &spatialReference)
void setProcessSpatialReference(const SpatialReference &spatialReference)
void setReturnM(bool returnM)
void setReturnZ(bool returnZ)
GeoprocessingParameters &operator=(const GeoprocessingParameters &other)
GeoprocessingParameters &operator=(GeoprocessingParameters &&other)

Detailed Description

Contains input parameters that are sent to the target geoprocessing task.

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.

Member Function Documentation

GeoprocessingParameters::GeoprocessingParameters()

Default constructor.

GeoprocessingParameters::GeoprocessingParameters(GeoprocessingExecutionType type)

Constructor that takes a GeoprocessingExecutionType type.

GeoprocessingParameters::GeoprocessingParameters(const GeoprocessingParameters &other)

Copy constructor from other GeoprocessingParameters.

GeoprocessingParameters::GeoprocessingParameters(GeoprocessingParameters &&other)

Move constructor from other GeoprocessingParameters.

GeoprocessingParameters::~GeoprocessingParameters()

Destructor

GeoprocessingExecutionType GeoprocessingParameters::executionType() const

Returns the execution type.

See also setExecutionType().

QMap<QString, 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.

SpatialReference GeoprocessingParameters::outputSpatialReference() const

Returns the output spatial reference.

See also setOutputSpatialReference().

SpatialReference GeoprocessingParameters::processSpatialReference() const

Returns the process spatial reference.

See also setProcessSpatialReference().

void GeoprocessingParameters::setExecutionType(GeoprocessingExecutionType type)

Sets the execution type to type.

See also executionType().

void GeoprocessingParameters::setInputs(const QMap<QString, GeoprocessingParameter *> &inputs)

Sets the input parameters to inputs.

The key contains the name of the input parameter and the value contains it's value.

See also inputs().

void GeoprocessingParameters::setOutputSpatialReference(const 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 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().

GeoprocessingParameters &GeoprocessingParameters::operator=(const GeoprocessingParameters &other)

Assignment operator from other GeoprocessingParameters.

GeoprocessingParameters &GeoprocessingParameters::operator=(GeoprocessingParameters &&other)

Move operator from other GeoprocessingParameters.


Feedback on this topic?