Skip To Content ArcGIS for Developers Sign In Dashboard

GeoprocessingParameterInfo Class

(Esri::ArcGISRuntime::GeoprocessingParameterInfo)

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

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

Public Functions

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

Detailed Description

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

Member Function Documentation

GeoprocessingParameterInfo::GeoprocessingParameterInfo()

Default constructor.

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

GeoprocessingParameterInfo::GeoprocessingParameterInfo(const GeoprocessingParameterInfo &other)

Copy constructor from other GeoprocessingParameterInfo.

GeoprocessingParameterInfo::GeoprocessingParameterInfo(GeoprocessingParameterInfo &&other)

Move constructor 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.

GeoprocessingParameterType GeoprocessingParameterInfo::dataType() const

Returns the type of the GeoprocessingParameter.

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.

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.

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.

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

Assignment operator from other GeoprocessingParameterInfo.

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

Move operator from other GeoprocessingParameterInfo.


Feedback on this topic?