QGIS API Documentation
3.12.1-București (121cc00ff0)
|
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, FlagIsModelOutput = 1 << 4 } |
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 |
QStringList | additionalExpressionContextVariables () const |
Returns a list of additional expression context variables which are available for use when evaluating this parameter. More... | |
QgsProcessingAlgorithm * | algorithm () const |
Returns a pointer to the algorithm which owns this parameter. More... | |
virtual QString | asPythonString (QgsProcessing::PythonOutputType outputType=QgsProcessing::PythonQgsProcessingAlgorithmSubclass) const |
Returns the parameter definition as a Python command which can be used within a Python Processing script. More... | |
virtual QString | asScriptCode () const |
Returns the parameter definition encoded in a string which can be used within a 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 | setAdditionalExpressionContextVariables (const QStringList &variables) |
Sets a list of additional expression context variables which are available for use when evaluating 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 | |
QStringList | mAdditionalExpressionVariables |
Additional expression context variables exposed for use by this parameter. More... | |
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 customize 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 206 of file qgsprocessingparameters.h.
Parameter flags.
Definition at line 283 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 1864 of file qgsprocessingparameters.cpp.
|
virtualdefault |
|
inline |
Returns a list of additional expression context variables which are available for use when evaluating this parameter.
The additional variables will be added to the variables exposed from the usual expression context available to the parameter. They can be used to expose variables which are ONLY available to this parameter.
The returned list should contain the variable names only, without the usual "@" prefix.
Definition at line 537 of file qgsprocessingparameters.h.
QgsProcessingAlgorithm * QgsProcessingParameterDefinition::algorithm | ( | ) | const |
Returns a pointer to the algorithm which owns this parameter.
May be nullptr
for non-owned parameters.
Definition at line 1950 of file qgsprocessingparameters.cpp.
|
virtual |
Returns the parameter definition as a Python command which can be used within a Python Processing script.
The outputType argument specifies the desired output format for the Python string, i.e. the intended end use of the generated Python code.
Reimplemented in QgsProcessingParameterMapTheme, QgsProcessingParameterCoordinateOperation, QgsProcessingParameterColor, QgsProcessingParameterLayoutItem, QgsProcessingParameterLayout, QgsProcessingParameterBand, QgsProcessingParameterFileDestination, QgsProcessingParameterVectorDestination, QgsProcessingParameterFeatureSink, QgsProcessingDestinationParameter, QgsProcessingParameterFeatureSource, QgsProcessingParameterField, QgsProcessingParameterVectorLayer, QgsProcessingParameterExpression, QgsProcessingParameterString, QgsProcessingParameterEnum, QgsProcessingParameterRange, QgsProcessingParameterScale, QgsProcessingParameterDistance, QgsProcessingParameterNumber, QgsProcessingParameterMultipleLayers, QgsProcessingParameterMatrix, and QgsProcessingParameterFile.
Definition at line 1904 of file qgsprocessingparameters.cpp.
|
virtual |
Returns the parameter definition encoded in a string which can be used within a Processing script.
Reimplemented in QgsProcessingParameterMapTheme, QgsProcessingParameterCoordinateOperation, QgsProcessingParameterColor, QgsProcessingParameterLayoutItem, QgsProcessingParameterLayout, QgsProcessingParameterBand, QgsProcessingParameterVectorDestination, QgsProcessingParameterFeatureSink, QgsProcessingParameterFeatureSource, QgsProcessingParameterField, QgsProcessingParameterAuthConfig, QgsProcessingParameterString, QgsProcessingParameterEnum, QgsProcessingParameterMultipleLayers, QgsProcessingParameterFile, and QgsProcessingParameterBoolean.
Definition at line 1894 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 QgsProcessingParameterMapTheme, QgsProcessingParameterColor, QgsProcessingParameterBand, QgsProcessingParameterFolderDestination, QgsProcessingParameterFileDestination, QgsProcessingParameterRasterDestination, QgsProcessingParameterVectorDestination, QgsProcessingParameterFeatureSink, QgsProcessingParameterFeatureSource, QgsProcessingParameterField, QgsProcessingParameterMeshLayer, QgsProcessingParameterVectorLayer, QgsProcessingParameterEnum, QgsProcessingParameterRasterLayer, QgsProcessingParameterRange, QgsProcessingParameterNumber, QgsProcessingParameterMultipleLayers, QgsProcessingParameterMatrix, QgsProcessingParameterFile, QgsProcessingParameterPoint, QgsProcessingParameterExtent, QgsProcessingParameterMapLayer, and QgsProcessingParameterCrs.
Definition at line 1871 of file qgsprocessingparameters.cpp.
|
pure virtual |
Creates a clone of the parameter definition.
Implemented in QgsProcessingParameterMapTheme, QgsProcessingParameterCoordinateOperation, QgsProcessingParameterColor, QgsProcessingParameterLayoutItem, QgsProcessingParameterLayout, QgsProcessingParameterBand, QgsProcessingParameterFolderDestination, QgsProcessingParameterFileDestination, QgsProcessingParameterRasterDestination, QgsProcessingParameterVectorDestination, QgsProcessingParameterFeatureSink, QgsProcessingParameterFeatureSource, QgsProcessingParameterField, QgsProcessingParameterMeshLayer, QgsProcessingParameterVectorLayer, QgsProcessingParameterExpression, QgsProcessingParameterAuthConfig, QgsProcessingParameterString, QgsProcessingParameterEnum, QgsProcessingParameterRasterLayer, QgsProcessingParameterRange, QgsProcessingParameterScale, QgsProcessingParameterDistance, QgsProcessingParameterNumber, QgsProcessingParameterMultipleLayers, QgsProcessingParameterMatrix, QgsProcessingParameterFile, QgsProcessingParameterPoint, QgsProcessingParameterExtent, QgsProcessingParameterMapLayer, QgsProcessingParameterCrs, and QgsProcessingParameterBoolean.
|
inline |
Returns the default value for the parameter.
Definition at line 349 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 QgsProcessingParameterLayoutItem, QgsProcessingParameterBand, QgsProcessingParameterField, QgsProcessingParameterExpression, and QgsProcessingParameterDistance.
Definition at line 442 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 336 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 509 of file qgsprocessingparameters.h.
|
inline |
Returns the property definition for dynamic properties.
Definition at line 488 of file qgsprocessingparameters.h.
|
inline |
Returns any flags associated with the parameter.
Definition at line 362 of file qgsprocessingparameters.h.
|
virtual |
Restores this parameter to a QVariantMap.
Subclasses should ensure that they call the base class method.
Reimplemented in QgsProcessingParameterMapTheme, QgsProcessingParameterCoordinateOperation, QgsProcessingParameterColor, QgsProcessingParameterLayoutItem, QgsProcessingParameterBand, QgsProcessingParameterFileDestination, QgsProcessingParameterVectorDestination, QgsProcessingParameterFeatureSink, QgsProcessingDestinationParameter, QgsProcessingParameterFeatureSource, QgsProcessingParameterField, QgsProcessingParameterVectorLayer, QgsProcessingParameterExpression, QgsProcessingParameterString, QgsProcessingParameterEnum, QgsProcessingParameterRange, QgsProcessingParameterDistance, QgsProcessingParameterNumber, QgsProcessingParameterMultipleLayers, QgsProcessingParameterMatrix, and QgsProcessingParameterFile.
Definition at line 1940 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 315 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 471 of file qgsprocessingparameters.h.
|
inline |
Returns the parameter's freeform metadata.
This is mostly used by parameter widget wrappers in order to customize their appearance and behavior.
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 customize their appearance and behavior.
Definition at line 429 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 322 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 1955 of file qgsprocessingparameters.cpp.
|
inline |
Sets a list of additional expression context variables which are available for use when evaluating this parameter.
The additional variables will be added to the variables exposed from the usual expression context available to the parameter. They can be used to expose variables which are ONLY available to this parameter.
The variables list should contain the variable names only, without the usual "@" prefix.
Definition at line 556 of file qgsprocessingparameters.h.
|
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 356 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 343 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 522 of file qgsprocessingparameters.h.
|
inline |
Sets the property definition for dynamic properties.
Definition at line 496 of file qgsprocessingparameters.h.
|
inline |
Sets the flags associated with the parameter.
Definition at line 368 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 480 of file qgsprocessingparameters.h.
|
inline |
Sets the parameter's freeform metadata.
This is mostly used by parameter widget wrappers in order to customize their appearance and behavior.
Definition at line 436 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 329 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 1960 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 QgsProcessingParameterMapTheme, QgsProcessingParameterCoordinateOperation, QgsProcessingParameterColor, QgsProcessingParameterLayoutItem, QgsProcessingParameterBand, QgsProcessingParameterFileDestination, QgsProcessingParameterVectorDestination, QgsProcessingParameterFeatureSink, QgsProcessingDestinationParameter, QgsProcessingParameterFeatureSource, QgsProcessingParameterField, QgsProcessingParameterVectorLayer, QgsProcessingParameterExpression, QgsProcessingParameterString, QgsProcessingParameterEnum, QgsProcessingParameterRange, QgsProcessingParameterDistance, QgsProcessingParameterNumber, QgsProcessingParameterMultipleLayers, QgsProcessingParameterMatrix, and QgsProcessingParameterFile.
Definition at line 1928 of file qgsprocessingparameters.cpp.
|
pure virtual |
Unique parameter type name.
Implemented in QgsProcessingParameterMapTheme, QgsProcessingParameterCoordinateOperation, QgsProcessingParameterColor, QgsProcessingParameterLayoutItem, QgsProcessingParameterLayout, QgsProcessingParameterBand, QgsProcessingParameterFolderDestination, QgsProcessingParameterFileDestination, QgsProcessingParameterRasterDestination, QgsProcessingParameterVectorDestination, QgsProcessingParameterFeatureSink, QgsProcessingParameterFeatureSource, QgsProcessingParameterField, QgsProcessingParameterMeshLayer, QgsProcessingParameterVectorLayer, QgsProcessingParameterExpression, QgsProcessingParameterAuthConfig, QgsProcessingParameterString, QgsProcessingParameterEnum, QgsProcessingParameterRasterLayer, QgsProcessingParameterRange, QgsProcessingParameterScale, QgsProcessingParameterDistance, 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.
Reimplemented in QgsProcessingParameterMapTheme, QgsProcessingParameterCoordinateOperation, QgsProcessingParameterColor, QgsProcessingParameterLayoutItem, QgsProcessingParameterLayout, QgsProcessingParameterBand, QgsProcessingParameterFileDestination, QgsProcessingParameterRasterDestination, QgsProcessingParameterVectorDestination, QgsProcessingParameterFeatureSink, QgsProcessingParameterFeatureSource, QgsProcessingParameterField, QgsProcessingParameterMeshLayer, QgsProcessingParameterVectorLayer, QgsProcessingParameterExpression, QgsProcessingParameterAuthConfig, QgsProcessingParameterString, QgsProcessingParameterEnum, QgsProcessingParameterRasterLayer, QgsProcessingParameterRange, QgsProcessingParameterNumber, QgsProcessingParameterMultipleLayers, QgsProcessingParameterMatrix, QgsProcessingParameterPoint, QgsProcessingParameterExtent, QgsProcessingParameterMapLayer, QgsProcessingParameterCrs, and QgsProcessingParameterBoolean.
Definition at line 1883 of file qgsprocessingparameters.cpp.
|
friend |
Definition at line 591 of file qgsprocessingparameters.h.
|
protected |
Additional expression context variables exposed for use by this parameter.
Definition at line 588 of file qgsprocessingparameters.h.
|
protected |
Pointer to algorithm which owns this parameter.
Definition at line 576 of file qgsprocessingparameters.h.
|
protected |
Default value for parameter.
Definition at line 567 of file qgsprocessingparameters.h.
|
protected |
Parameter description.
Definition at line 564 of file qgsprocessingparameters.h.
|
protected |
Linked vector layer parameter name for dynamic properties.
Definition at line 585 of file qgsprocessingparameters.h.
|
protected |
Parameter flags.
Definition at line 570 of file qgsprocessingparameters.h.
|
protected |
True for dynamic parameters, which can have data-defined (QgsProperty) based values.
Definition at line 579 of file qgsprocessingparameters.h.
|
protected |
Freeform metadata for parameter. Mostly used by widget wrappers to customize their appearance and behavior.
Definition at line 573 of file qgsprocessingparameters.h.
|
protected |
Parameter name.
Definition at line 561 of file qgsprocessingparameters.h.
|
protected |
Data defined property definition.
Definition at line 582 of file qgsprocessingparameters.h.