;

GeoprocessingParameters Class

  • 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

    This class was introduced in Esri::ArcGISRuntime 100.0.

    Public Functions

    GeoprocessingParameters(Esri::ArcGISRuntime::GeoprocessingParameters &&other)
    GeoprocessingParameters(const Esri::ArcGISRuntime::GeoprocessingParameters &other)
    GeoprocessingParameters(Esri::ArcGISRuntime::GeoprocessingExecutionType type)
    GeoprocessingParameters()
    Esri::ArcGISRuntime::GeoprocessingParameters &operator=(Esri::ArcGISRuntime::GeoprocessingParameters &&other)
    Esri::ArcGISRuntime::GeoprocessingParameters &operator=(const 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)

    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.

    Member Function Documentation

    GeoprocessingParameters::GeoprocessingParameters(Esri::ArcGISRuntime::GeoprocessingParameters &&other)

    Move constructor from other GeoprocessingParameters.

    GeoprocessingParameters::GeoprocessingParameters(const Esri::ArcGISRuntime::GeoprocessingParameters &other)

    Copy constructor from other GeoprocessingParameters.

    GeoprocessingParameters::GeoprocessingParameters(Esri::ArcGISRuntime::GeoprocessingExecutionType type)

    Constructor that takes a GeoprocessingExecutionType type.

    GeoprocessingParameters::GeoprocessingParameters()

    Default constructor.

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

    Move operator from other GeoprocessingParameters.

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

    Assignment operator 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 it's 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().

    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.