QGIS API Documentation
3.0.2-Girona (307d082)
|
Base class for the definition of processing parameters. More...
#include <qgsprocessingparameters.h>
Public Types | |
enum | Flag { FlagAdvanced = 1 << 1, FlagHidden = 1 << 2, FlagOptional = 1 << 3 } |
Parameter flags. More... | |
Public Member Functions | |
QgsProcessingParameterDefinition (const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false) | |
Constructor for QgsProcessingParameterDefinition. More... | |
virtual | ~QgsProcessingParameterDefinition ()=default |
QgsProcessingAlgorithm * | algorithm () const |
Returns a pointer to the algorithm which owns this parameter. More... | |
virtual QString | asScriptCode () const |
Returns the parameter definition encoded in a string which can be used within a Python processing script. More... | |
virtual bool | checkValueIsAcceptable (const QVariant &input, QgsProcessingContext *context=nullptr) const |
Checks whether the specified input value is acceptable for the parameter. More... | |
virtual QgsProcessingParameterDefinition * | clone () const =0 |
Creates a clone of the parameter definition. More... | |
QVariant | defaultValue () const |
Returns the default value for the parameter. More... | |
virtual QStringList | dependsOnOtherParameters () const |
Returns a list of other parameter names on which this parameter is dependent (e.g. More... | |
QString | description () const |
Returns the description for the parameter. More... | |
QString | dynamicLayerParameterName () const |
Returns the name of the parameter for a layer linked to a dynamic parameter, or an empty string if this is not set. More... | |
QgsPropertyDefinition | dynamicPropertyDefinition () const |
Returns the property definition for dynamic properties. More... | |
Flags | flags () const |
Returns any flags associated with the parameter. More... | |
virtual bool | fromVariantMap (const QVariantMap &map) |
Restores this parameter to a QVariantMap. More... | |
virtual bool | isDestination () const |
Returns true if this parameter represents a file or layer destination, e.g. More... | |
bool | isDynamic () const |
Returns true if the parameter supports is dynamic, and can support data-defined values (i.e. More... | |
QVariantMap | metadata () const |
Returns the parameter's freeform metadata. More... | |
QVariantMap & | metadata () |
Returns the parameter's freeform metadata. More... | |
QString | name () const |
Returns the name of the parameter. More... | |
QgsProcessingProvider * | provider () const |
Returns a pointer to the provider for the algorithm which owns this parameter. More... | |
void | setDefaultValue (const QVariant &value) |
Sets the default value for the parameter. More... | |
void | setDescription (const QString &description) |
Sets the description for the parameter. More... | |
void | setDynamicLayerParameterName (const QString &name) |
Sets the name for the parameter for a layer linked to a dynamic parameter, or an empty string if this is not set. More... | |
void | setDynamicPropertyDefinition (const QgsPropertyDefinition &definition) |
Sets the property definition for dynamic properties. More... | |
void | setFlags (Flags flags) |
Sets the flags associated with the parameter. More... | |
void | setIsDynamic (bool dynamic) |
Sets whether the parameter is dynamic, and can support data-defined values (i.e. More... | |
void | setMetadata (const QVariantMap &metadata) |
Sets the parameter's freeform metadata. More... | |
void | setName (const QString &name) |
Sets the name of the parameter. More... | |
virtual QString | toolTip () const |
Returns a formatted tooltip for use with the parameter, which gives helpful information like parameter description, ID, and extra content like default values (depending on parameter type). More... | |
virtual QVariantMap | toVariantMap () const |
Saves this parameter to a QVariantMap. More... | |
virtual QString | type () const =0 |
Unique parameter type name. More... | |
virtual QString | valueAsPythonString (const QVariant &value, QgsProcessingContext &context) const |
Returns a string version of the parameter input value, which is suitable for use as an input parameter value when running an algorithm directly from a Python command. More... | |
Protected Attributes | |
QgsProcessingAlgorithm * | mAlgorithm = nullptr |
Pointer to algorithm which owns this parameter. More... | |
QVariant | mDefault |
Default value for parameter. More... | |
QString | mDescription |
Parameter description. More... | |
QString | mDynamicLayerParameterName |
Linked vector layer parameter name for dynamic properties. More... | |
Flags | mFlags |
Parameter flags. More... | |
bool | mIsDynamic = false |
True for dynamic parameters, which can have data-defined (QgsProperty) based values. More... | |
QVariantMap | mMetadata |
Freeform metadata for parameter. Mostly used by widget wrappers to customise their appearance and behavior. More... | |
QString | mName |
Parameter name. More... | |
QgsPropertyDefinition | mPropertyDefinition |
Data defined property definition. More... | |
Friends | |
class | QgsProcessingAlgorithm |
Base class for the definition of processing parameters.
Parameter definitions encapsulate properties regarding the behavior of parameters, their acceptable ranges, defaults, etc.
Definition at line 186 of file qgsprocessingparameters.h.
Parameter flags.
Definition at line 245 of file qgsprocessingparameters.h.
QgsProcessingParameterDefinition::QgsProcessingParameterDefinition | ( | const QString & | name, |
const QString & | description = QString() , |
||
const QVariant & | defaultValue = QVariant() , |
||
bool | optional = false |
||
) |
Constructor for QgsProcessingParameterDefinition.
Definition at line 1200 of file qgsprocessingparameters.cpp.
|
virtualdefault |
QgsProcessingAlgorithm * QgsProcessingParameterDefinition::algorithm | ( | ) | const |
Returns a pointer to the algorithm which owns this parameter.
May be nullptr for non-owned parameters.
Definition at line 1258 of file qgsprocessingparameters.cpp.
|
virtual |
Returns the parameter definition encoded in a string which can be used within a Python processing script.
Reimplemented in QgsProcessingParameterBand, QgsProcessingParameterVectorDestination, QgsProcessingParameterFeatureSink, QgsProcessingParameterFeatureSource, QgsProcessingParameterField, QgsProcessingParameterString, QgsProcessingParameterEnum, QgsProcessingParameterMultipleLayers, QgsProcessingParameterFile, and QgsProcessingParameterBoolean.
Definition at line 1226 of file qgsprocessingparameters.cpp.
|
virtual |
Checks whether the specified input value is acceptable for the parameter.
Returns true if the value can be accepted. The optional context parameter can be specified to allow a more stringent check to be performed, capable of checking for the presence of required layers and other factors within the context.
Reimplemented in QgsProcessingParameterBand, QgsProcessingParameterFolderDestination, QgsProcessingParameterFileDestination, QgsProcessingParameterRasterDestination, QgsProcessingParameterVectorDestination, QgsProcessingParameterFeatureSink, QgsProcessingParameterFeatureSource, QgsProcessingParameterField, QgsProcessingParameterVectorLayer, QgsProcessingParameterEnum, QgsProcessingParameterRasterLayer, QgsProcessingParameterRange, QgsProcessingParameterNumber, QgsProcessingParameterMultipleLayers, QgsProcessingParameterMatrix, QgsProcessingParameterFile, QgsProcessingParameterPoint, QgsProcessingParameterExtent, QgsProcessingParameterMapLayer, and QgsProcessingParameterCrs.
Definition at line 1207 of file qgsprocessingparameters.cpp.
|
pure virtual |
Creates a clone of the parameter definition.
Implemented in QgsProcessingParameterBand, QgsProcessingParameterFolderDestination, QgsProcessingParameterFileDestination, QgsProcessingParameterRasterDestination, QgsProcessingParameterVectorDestination, QgsProcessingParameterFeatureSink, QgsProcessingParameterFeatureSource, QgsProcessingParameterField, QgsProcessingParameterVectorLayer, QgsProcessingParameterExpression, QgsProcessingParameterString, QgsProcessingParameterEnum, QgsProcessingParameterRasterLayer, QgsProcessingParameterRange, QgsProcessingParameterNumber, QgsProcessingParameterMultipleLayers, QgsProcessingParameterMatrix, QgsProcessingParameterFile, QgsProcessingParameterPoint, QgsProcessingParameterExtent, QgsProcessingParameterMapLayer, QgsProcessingParameterCrs, and QgsProcessingParameterBoolean.
|
inline |
Returns the default value for the parameter.
Definition at line 310 of file qgsprocessingparameters.h.
|
inlinevirtual |
Returns a list of other parameter names on which this parameter is dependent (e.g.
field parameters which depend on a parent layer parameter).
Reimplemented in QgsProcessingParameterBand, QgsProcessingParameterField, and QgsProcessingParameterExpression.
Definition at line 393 of file qgsprocessingparameters.h.
|
inline |
Returns the description for the parameter.
This is the user-visible string used to identify this parameter.
Definition at line 297 of file qgsprocessingparameters.h.
|
inline |
Returns the name of the parameter for a layer linked to a dynamic parameter, or an empty string if this is not set.
Dynamic parameters (see isDynamic()) can have an optional vector layer parameter linked to them, which indicates which layer the fields and values will be available from when evaluating the dynamic parameter.
Definition at line 460 of file qgsprocessingparameters.h.
|
inline |
Returns the property definition for dynamic properties.
Definition at line 439 of file qgsprocessingparameters.h.
|
inline |
Returns any flags associated with the parameter.
Definition at line 323 of file qgsprocessingparameters.h.
|
virtual |
Restores this parameter to a QVariantMap.
Subclasses should ensure that they call the base class method.
Reimplemented in QgsProcessingParameterBand, QgsProcessingParameterFileDestination, QgsProcessingParameterVectorDestination, QgsProcessingParameterFeatureSink, QgsProcessingDestinationParameter, QgsProcessingParameterFeatureSource, QgsProcessingParameterField, QgsProcessingParameterVectorLayer, QgsProcessingParameterExpression, QgsProcessingParameterString, QgsProcessingParameterEnum, QgsProcessingParameterRange, QgsProcessingParameterNumber, QgsProcessingParameterMultipleLayers, QgsProcessingParameterMatrix, and QgsProcessingParameterFile.
Definition at line 1248 of file qgsprocessingparameters.cpp.
|
inlinevirtual |
Returns true if this parameter represents a file or layer destination, e.g.
parameters which are used for the destination for layers output by an algorithm will return true.
Reimplemented in QgsProcessingDestinationParameter.
Definition at line 276 of file qgsprocessingparameters.h.
|
inline |
Returns true if the parameter supports is dynamic, and can support data-defined values (i.e.
QgsProperty based values).
Definition at line 422 of file qgsprocessingparameters.h.
|
inline |
Returns the parameter's freeform metadata.
This is mostly used by parameter widget wrappers in order to customise their appearance and behavior.
Definition at line 373 of file qgsprocessingparameters.h.
|
inline |
Returns the parameter's freeform metadata.
This is mostly used by parameter widget wrappers in order to customise their appearance and behavior.
Definition at line 380 of file qgsprocessingparameters.h.
|
inline |
Returns the name of the parameter.
This is the internal identifier by which algorithms access this parameter.
Definition at line 283 of file qgsprocessingparameters.h.
QgsProcessingProvider * QgsProcessingParameterDefinition::provider | ( | ) | const |
Returns a pointer to the provider for the algorithm which owns this parameter.
May be nullptr for non-owned parameters or algorithms.
Definition at line 1263 of file qgsprocessingparameters.cpp.
|
inline |
Sets the default value for the parameter.
Caller takes responsibility to ensure that value is a valid input for the parameter subclass.
Definition at line 317 of file qgsprocessingparameters.h.
|
inline |
Sets the description for the parameter.
This is the user-visible string used to identify this parameter.
Definition at line 304 of file qgsprocessingparameters.h.
|
inline |
Sets the name for the parameter for a layer linked to a dynamic parameter, or an empty string if this is not set.
Dynamic parameters (see isDynamic()) can have an optional vector layer parameter linked to them, which indicates which layer the fields and values will be available from when evaluating the dynamic parameter.
Definition at line 473 of file qgsprocessingparameters.h.
|
inline |
Sets the property definition for dynamic properties.
Definition at line 447 of file qgsprocessingparameters.h.
|
inline |
Sets the flags associated with the parameter.
Definition at line 329 of file qgsprocessingparameters.h.
|
inline |
Sets whether the parameter is dynamic, and can support data-defined values (i.e.
QgsProperty based values).
Definition at line 431 of file qgsprocessingparameters.h.
|
inline |
Sets the parameter's freeform metadata.
This is mostly used by parameter widget wrappers in order to customise their appearance and behavior.
Definition at line 387 of file qgsprocessingparameters.h.
|
inline |
Sets the name of the parameter.
This is the internal identifier by which algorithms access this parameter.
Definition at line 290 of file qgsprocessingparameters.h.
|
virtual |
Returns a formatted tooltip for use with the parameter, which gives helpful information like parameter description, ID, and extra content like default values (depending on parameter type).
Reimplemented in QgsProcessingParameterNumber.
Definition at line 1268 of file qgsprocessingparameters.cpp.
|
virtual |
Saves this parameter to a QVariantMap.
Subclasses should ensure that they call the base class method and then extend the result with additional properties.
Reimplemented in QgsProcessingParameterBand, QgsProcessingParameterFileDestination, QgsProcessingParameterVectorDestination, QgsProcessingParameterFeatureSink, QgsProcessingDestinationParameter, QgsProcessingParameterFeatureSource, QgsProcessingParameterField, QgsProcessingParameterVectorLayer, QgsProcessingParameterExpression, QgsProcessingParameterString, QgsProcessingParameterEnum, QgsProcessingParameterRange, QgsProcessingParameterNumber, QgsProcessingParameterMultipleLayers, QgsProcessingParameterMatrix, and QgsProcessingParameterFile.
Definition at line 1236 of file qgsprocessingparameters.cpp.
|
pure virtual |
Unique parameter type name.
Implemented in QgsProcessingParameterBand, QgsProcessingParameterFolderDestination, QgsProcessingParameterFileDestination, QgsProcessingParameterRasterDestination, QgsProcessingParameterVectorDestination, QgsProcessingParameterFeatureSink, QgsProcessingParameterFeatureSource, QgsProcessingParameterField, QgsProcessingParameterVectorLayer, QgsProcessingParameterExpression, QgsProcessingParameterString, QgsProcessingParameterEnum, QgsProcessingParameterRasterLayer, QgsProcessingParameterRange, QgsProcessingParameterNumber, QgsProcessingParameterMultipleLayers, QgsProcessingParameterMatrix, QgsProcessingParameterFile, QgsProcessingParameterPoint, QgsProcessingParameterExtent, QgsProcessingParameterMapLayer, QgsProcessingParameterCrs, and QgsProcessingParameterBoolean.
|
virtual |
Returns a string version of the parameter input value, which is suitable for use as an input parameter value when running an algorithm directly from a Python command.
The returned value must be correctly escaped - e.g. string values must be wrapped in ' 's.
Reimplemented in QgsProcessingParameterBand, QgsProcessingParameterFileDestination, QgsProcessingParameterRasterDestination, QgsProcessingParameterVectorDestination, QgsProcessingParameterFeatureSink, QgsProcessingParameterFeatureSource, QgsProcessingParameterField, QgsProcessingParameterVectorLayer, QgsProcessingParameterExpression, QgsProcessingParameterString, QgsProcessingParameterEnum, QgsProcessingParameterRasterLayer, QgsProcessingParameterRange, QgsProcessingParameterNumber, QgsProcessingParameterMultipleLayers, QgsProcessingParameterMatrix, QgsProcessingParameterPoint, QgsProcessingParameterExtent, QgsProcessingParameterMapLayer, QgsProcessingParameterCrs, and QgsProcessingParameterBoolean.
Definition at line 1218 of file qgsprocessingparameters.cpp.
|
friend |
Definition at line 505 of file qgsprocessingparameters.h.
|
protected |
Pointer to algorithm which owns this parameter.
Definition at line 493 of file qgsprocessingparameters.h.
|
protected |
Default value for parameter.
Definition at line 484 of file qgsprocessingparameters.h.
|
protected |
Parameter description.
Definition at line 481 of file qgsprocessingparameters.h.
|
protected |
Linked vector layer parameter name for dynamic properties.
Definition at line 502 of file qgsprocessingparameters.h.
|
protected |
Parameter flags.
Definition at line 487 of file qgsprocessingparameters.h.
|
protected |
True for dynamic parameters, which can have data-defined (QgsProperty) based values.
Definition at line 496 of file qgsprocessingparameters.h.
|
protected |
Freeform metadata for parameter. Mostly used by widget wrappers to customise their appearance and behavior.
Definition at line 490 of file qgsprocessingparameters.h.
|
protected |
Parameter name.
Definition at line 478 of file qgsprocessingparameters.h.
|
protected |
Data defined property definition.
Definition at line 499 of file qgsprocessingparameters.h.