GeoprocessingParameterInfo Class

  • GeoprocessingParameterInfo
  • class Esri::ArcGISRuntime::GeoprocessingParameterInfo

    Information about a single input or output parameter of a geoprocessing task. More...

    Header: #include <GeoprocessingParameterInfo.h>
    Since: Esri::ArcGISRuntime 100.1

    This class was introduced in Esri::ArcGISRuntime 100.1.

    Public Functions

    GeoprocessingParameterInfo(Esri::ArcGISRuntime::GeoprocessingParameterInfo &&other)
    GeoprocessingParameterInfo(const Esri::ArcGISRuntime::GeoprocessingParameterInfo &other)
    GeoprocessingParameterInfo()
    Esri::ArcGISRuntime::GeoprocessingParameterInfo &operator=(Esri::ArcGISRuntime::GeoprocessingParameterInfo &&other)
    Esri::ArcGISRuntime::GeoprocessingParameterInfo &operator=(const Esri::ArcGISRuntime::GeoprocessingParameterInfo &other)
    ~GeoprocessingParameterInfo()
    QString category() const
    QStringList choiceList() const
    Esri::ArcGISRuntime::GeoprocessingParameterType dataType() const
    Esri::ArcGISRuntime::GeoprocessingParameter *defaultParameter(QObject *parent = nullptr) const
    QString description() const
    Esri::ArcGISRuntime::GeoprocessingParameterDirection direction() const
    QString displayName() const
    bool isEmpty() const
    bool isFeaturesRequireGeometry() const
    bool isRequired() const
    Esri::ArcGISRuntime::GeoprocessingParameterType multiValueDataType() const
    QString name() const

    Detailed Description

    Member Function Documentation

    GeoprocessingParameterInfo::GeoprocessingParameterInfo(Esri::ArcGISRuntime::GeoprocessingParameterInfo &&other)

    Move constructor from other GeoprocessingParameterInfo.

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

    Copy constructor from other GeoprocessingParameterInfo.

    GeoprocessingParameterInfo::GeoprocessingParameterInfo()

    Default constructor.

    Warning: This is for convenience only and will construct an empty object.

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

    Move operator from other GeoprocessingParameterInfo.

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

    Assignment operator from other GeoprocessingParameterInfo.

    GeoprocessingParameterInfo::~GeoprocessingParameterInfo()

    Destructor.

    QString GeoprocessingParameterInfo::category() const

    Returns the category of the GeoprocessingParameter.

    QStringList GeoprocessingParameterInfo::choiceList() const

    Returns a list of value choices for the GeoprocessingParameter.

    Esri::ArcGISRuntime::GeoprocessingParameterType GeoprocessingParameterInfo::dataType() const

    Returns the type of the GeoprocessingParameter.

    Esri::ArcGISRuntime::GeoprocessingParameter *GeoprocessingParameterInfo::defaultParameter(QObject *parent = nullptr) const

    Returns the GeoprocessingParameter this GeoprocessingParameterInfo object refers to, set to the default values with an optional parent.

    QString GeoprocessingParameterInfo::description() const

    Returns the description of the GeoprocessingParameter.

    Esri::ArcGISRuntime::GeoprocessingParameterDirection GeoprocessingParameterInfo::direction() const

    Returns the direction of the GeoprocessingParameter.

    QString GeoprocessingParameterInfo::displayName() const

    Returns the display name specified by the GeoprocessingParameter.

    bool GeoprocessingParameterInfo::isEmpty() const

    Returns true if this GeoprocessingParameterInfo is empty.

    bool GeoprocessingParameterInfo::isFeaturesRequireGeometry() const

    Returns whether a geoprocessing feature parameter requires features with geometry.

    bool GeoprocessingParameterInfo::isRequired() const

    Returns true if the parameter is required and false otherwise.

    Esri::ArcGISRuntime::GeoprocessingParameterType GeoprocessingParameterInfo::multiValueDataType() const

    Returns the multi-value data type of the GeoprocessingParameter.

    This is only applicable if this parameter info describes a multi-value.

    QString GeoprocessingParameterInfo::name() const

    Returns the name of the GeoprocessingParameter.

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

    You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

    Your ArcGIS portal

    Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

    Your ArcGIS Location Platform dashboard

    Manage billing, monitor service usage, and access additional resources.

    Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

    Close