A multi value input or output parameter which contains a collection of values having a single geoprocessing parameter type. More...
| Header: | #include <GeoprocessingMultiValue.h> |
| Since: | Esri::ArcGISRuntime 100.0 |
| Inherits: | Esri::ArcGISRuntime::GeoprocessingParameter |
Public Functions
| GeoprocessingMultiValue(QObject *parent = nullptr) | |
| GeoprocessingMultiValue(Esri::ArcGISRuntime::GeoprocessingParameterType valueParameterType, QObject *parent = nullptr) | |
| GeoprocessingMultiValue(Esri::ArcGISRuntime::GeoprocessingParameterType valueParameterType, const QList<Esri::ArcGISRuntime::GeoprocessingParameter *> &values, QObject *parent = nullptr) | |
| virtual | ~GeoprocessingMultiValue() override |
| void | setValueParameterType(Esri::ArcGISRuntime::GeoprocessingParameterType valueParameterType) |
| void | setValues(const QList<Esri::ArcGISRuntime::GeoprocessingParameter *> &values) |
| Esri::ArcGISRuntime::GeoprocessingParameterType | valueParameterType() const |
| QList<Esri::ArcGISRuntime::GeoprocessingParameter *> | values() const |
Detailed Description
Corresponds to GPMultiValue parameter type on the service.
All values contained in this GeoprocessingMultiValue must be of the same GeoprocessingParameterType.
{GeoprocessingMultiValue(Esri::ArcGISRuntime::GeoprocessingParameterType, const QList<Esri::ArcGISRuntime::GeoprocessingParameter*>&, QObject*)}
See also Esri::ArcGISRuntime::GeoprocessingMultiValue::GeoprocessingMultiValue(Esri::ArcGISRuntime::GeoprocessingParameterType, const QList<Esri::ArcGISRuntime::GeoprocessingParameter*>&, QObject*).
Member Function Documentation
[explicit] GeoprocessingMultiValue::GeoprocessingMultiValue (QObject *parent = nullptr)
Constructor that accepts an optional parent object.
[explicit] GeoprocessingMultiValue::GeoprocessingMultiValue (Esri::ArcGISRuntime::GeoprocessingParameterType valueParameterType , QObject *parent = nullptr)
Create a geoprocessing multi value parameter with the given geoprocessing parameter type.
- valueParameterType - The type of the parameters in the collection.
- parent - The optional parent QObject.
Any parameters added to the values collection should match the given parameter_type or an error will be emitted.
GeoprocessingMultiValue::GeoprocessingMultiValue (Esri::ArcGISRuntime::GeoprocessingParameterType valueParameterType , const QList<Esri::ArcGISRuntime::GeoprocessingParameter *> &values, QObject *parent = nullptr)
Create a geoprocessing multi value parameter with the given collection of geoprocessing parameters.
- valueParameterType - The type of the parameters in the collection.
- values - The collection of geoprocessing parameters for this parameter. The element type must be GeoprocessingParameter.
- parent - The optional parent QObject.
All of the geoprocessing parameters in the given QList should be of the same type. This type should match the given parameter_type or an error will be emitted.
[override virtual] GeoprocessingMultiValue::~GeoprocessingMultiValue ()
Destructor.
void GeoprocessingMultiValue::setValueParameterType (Esri::ArcGISRuntime::GeoprocessingParameterType valueParameterType )
Sets the GeoprocessingParameterType to valueParameterType.
See also valueParameterType().
void GeoprocessingMultiValue::setValues (const QList<Esri::ArcGISRuntime::GeoprocessingParameter *> &values)
Sets the list of values to values.
See also values().
Esri::ArcGISRuntime::GeoprocessingParameterType GeoprocessingMultiValue::valueParameterType () const
Returns the type of the geoprocessing parameters in this multi-value parameter's collection.
An error will be emitted if the given type doesn't match that of the collection if the collection has already been set.
See also setValueParameterType().
QList<Esri::ArcGISRuntime::GeoprocessingParameter *> GeoprocessingMultiValue::values() const
Returns the collection of geoprocessing parameters from this parameter.
All of the geoprocessing parameters in the given QList should be of the same type. If the parameter type has been set in this multi value, the given collection of geoprocessing parameters must be of the matching type or an error will be emitted.
See also setValues().