QGIS API Documentation 3.39.0-Master (bca3cdb6021)
|
Base class for the definition of processing parameters. More...
#include <qgsprocessingparameters.h>
Public Types | |
enum class | ValueAsStringFlag : int { AllowMapLayerValues = 1 << 0 } |
Flags for passing to the valueAsStringPrivate() method. More... | |
typedef QFlags< ValueAsStringFlag > | ValueAsStringFlags |
Public Member Functions | |
QgsProcessingParameterDefinition (const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false, const QString &help=QString()) | |
Constructor for QgsProcessingParameterDefinition. | |
virtual | ~QgsProcessingParameterDefinition ()=default |
QStringList | additionalExpressionContextVariables () const |
Returns a list of additional expression context variables which are available for use when evaluating this parameter. | |
QgsProcessingAlgorithm * | algorithm () const |
Returns a pointer to the algorithm which owns this parameter. | |
virtual QString | asPythonString (QgsProcessing::PythonOutputType outputType=QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass) const |
Returns the parameter definition as a Python command which can be used within a Python Processing script. | |
virtual QString | asScriptCode () const |
Returns the parameter definition encoded in a string which can be used within a Processing script. | |
virtual bool | checkValueIsAcceptable (const QVariant &input, QgsProcessingContext *context=nullptr) const |
Checks whether the specified input value is acceptable for the parameter. | |
virtual QgsProcessingParameterDefinition * | clone () const =0 |
Creates a clone of the parameter definition. | |
QVariant | defaultValue () const |
Returns the default value for the parameter. | |
QVariant | defaultValueForGui () const |
Returns the default value to use for the parameter in a GUI. | |
virtual QStringList | dependsOnOtherParameters () const |
Returns a list of other parameter names on which this parameter is dependent (e.g. | |
QString | description () const |
Returns the description for the parameter. | |
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. | |
QgsPropertyDefinition | dynamicPropertyDefinition () const |
Returns the property definition for dynamic properties. | |
Qgis::ProcessingParameterFlags | flags () const |
Returns any flags associated with the parameter. | |
virtual bool | fromVariantMap (const QVariantMap &map) |
Restores this parameter to a QVariantMap. | |
QVariant | guiDefaultValueOverride () const |
Returns the default value to use in the GUI for the parameter. | |
QString | help () const |
Returns the help for the parameter. | |
virtual bool | isDestination () const |
Returns true if this parameter represents a file or layer destination, e.g. | |
bool | isDynamic () const |
Returns true if the parameter supports is dynamic, and can support data-defined values (i.e. | |
QVariantMap & | metadata () |
Returns the parameter's freeform metadata. | |
QVariantMap | metadata () const |
Returns the parameter's freeform metadata. | |
QString | name () const |
Returns the name of the parameter. | |
QgsProcessingProvider * | provider () const |
Returns a pointer to the provider for the algorithm which owns this parameter. | |
void | setAdditionalExpressionContextVariables (const QStringList &variables) |
Sets a list of additional expression context variables which are available for use when evaluating this parameter. | |
void | setDefaultValue (const QVariant &value) |
Sets the default value for the parameter. | |
void | setDescription (const QString &description) |
Sets the description for the parameter. | |
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. | |
void | setDynamicPropertyDefinition (const QgsPropertyDefinition &definition) |
Sets the property definition for dynamic properties. | |
void | setFlags (Qgis::ProcessingParameterFlags flags) |
Sets the flags associated with the parameter. | |
void | setGuiDefaultValueOverride (const QVariant &value) |
Sets the default value to use for the parameter in GUI widgets. | |
void | setHelp (const QString &help) |
Sets the help for the parameter. | |
void | setIsDynamic (bool dynamic) |
Sets whether the parameter is dynamic, and can support data-defined values (i.e. | |
void | setMetadata (const QVariantMap &metadata) |
Sets the parameter's freeform metadata. | |
void | setName (const QString &name) |
Sets the name of the parameter. | |
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). | |
virtual QVariantMap | toVariantMap () const |
Saves this parameter to a QVariantMap. | |
virtual QString | type () const =0 |
Unique parameter type name. | |
virtual QVariant | valueAsJsonObject (const QVariant &value, QgsProcessingContext &context) const |
Returns a version of the parameter input value, which is suitable for use in a JSON object. | |
virtual QString | valueAsPythonComment (const QVariant &value, QgsProcessingContext &context) const |
Returns a Python comment explaining a parameter value, or an empty string if no comment is required. | |
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. | |
virtual QString | valueAsString (const QVariant &value, QgsProcessingContext &context, bool &ok) const |
Returns a string version of the parameter input value (if possible). | |
virtual QStringList | valueAsStringList (const QVariant &value, QgsProcessingContext &context, bool &ok) const |
Returns a string list version of the parameter input value (if possible). | |
Protected Member Functions | |
QVariant | defaultGuiValueFromSetting () const |
Default gui value for an algorithm parameter from settings. | |
QVariant | valueAsJsonObjectPrivate (const QVariant &value, QgsProcessingContext &context, ValueAsStringFlags flags) const |
Internal method for evaluating values as JSON objects. | |
QString | valueAsStringPrivate (const QVariant &value, QgsProcessingContext &context, bool &ok, ValueAsStringFlags flags) const |
Internal method for evaluating values as string. | |
Protected Attributes | |
QStringList | mAdditionalExpressionVariables |
Additional expression context variables exposed for use by this parameter. | |
QgsProcessingAlgorithm * | mAlgorithm = nullptr |
Pointer to algorithm which owns this parameter. | |
QVariant | mDefault |
Default value for parameter. | |
QString | mDescription |
Parameter description. | |
QString | mDynamicLayerParameterName |
Linked vector layer parameter name for dynamic properties. | |
Qgis::ProcessingParameterFlags | mFlags |
Parameter flags. | |
QVariant | mGuiDefault |
Default value for parameter in GUI. | |
QString | mHelp |
Parameter help. | |
bool | mIsDynamic = false |
True for dynamic parameters, which can have data-defined (QgsProperty) based values. | |
QVariantMap | mMetadata |
Freeform metadata for parameter. Mostly used by widget wrappers to customize their appearance and behavior. | |
QString | mName |
Parameter name. | |
QgsPropertyDefinition | mPropertyDefinition |
Data defined property definition. | |
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 333 of file qgsprocessingparameters.h.
typedef QFlags< ValueAsStringFlag > QgsProcessingParameterDefinition::ValueAsStringFlags |
Definition at line 853 of file qgsprocessingparameters.h.
|
strong |
Flags for passing to the valueAsStringPrivate() method.
Enumerator | |
---|---|
AllowMapLayerValues | Enable map layer value handling. |
Definition at line 849 of file qgsprocessingparameters.h.
QgsProcessingParameterDefinition::QgsProcessingParameterDefinition | ( | const QString & | name, |
const QString & | description = QString() , |
||
const QVariant & | defaultValue = QVariant() , |
||
bool | optional = false , |
||
const QString & | help = QString() |
||
) |
Constructor for QgsProcessingParameterDefinition.
Definition at line 2453 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 819 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 2990 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 QgsProcessingParameterAggregate, QgsProcessingParameterAlignRasterLayers, QgsProcessingParameterDxfLayers, QgsProcessingParameterFieldMapping, QgsProcessingParameterMeshDatasetGroups, QgsProcessingParameterMeshDatasetTime, QgsProcessingParameterGeometry, QgsProcessingParameterFile, QgsProcessingParameterMatrix, QgsProcessingParameterMultipleLayers, QgsProcessingParameterNumber, QgsProcessingParameterDistance, QgsProcessingParameterArea, QgsProcessingParameterVolume, QgsProcessingParameterDuration, QgsProcessingParameterScale, QgsProcessingParameterRange, QgsProcessingParameterEnum, QgsProcessingParameterString, QgsProcessingParameterExpression, QgsProcessingParameterVectorLayer, QgsProcessingParameterMapLayer, QgsProcessingParameterField, QgsProcessingParameterFeatureSource, QgsProcessingDestinationParameter, QgsProcessingParameterFeatureSink, QgsProcessingParameterVectorDestination, QgsProcessingParameterFileDestination, QgsProcessingParameterBand, QgsProcessingParameterLayout, QgsProcessingParameterLayoutItem, QgsProcessingParameterColor, QgsProcessingParameterCoordinateOperation, QgsProcessingParameterMapTheme, QgsProcessingParameterDateTime, QgsProcessingParameterProviderConnection, QgsProcessingParameterDatabaseSchema, QgsProcessingParameterDatabaseTable, QgsProcessingParameterPointCloudAttribute, QgsProcessingParameterTinInputLayers, and QgsProcessingParameterVectorTileWriterLayers.
Definition at line 2939 of file qgsprocessingparameters.cpp.
|
virtual |
Returns the parameter definition encoded in a string which can be used within a Processing script.
Reimplemented in QgsProcessingParameterBoolean, QgsProcessingParameterGeometry, QgsProcessingParameterFile, QgsProcessingParameterMultipleLayers, QgsProcessingParameterEnum, QgsProcessingParameterString, QgsProcessingParameterAuthConfig, QgsProcessingParameterMapLayer, QgsProcessingParameterField, QgsProcessingParameterFeatureSource, QgsProcessingParameterFeatureSink, QgsProcessingParameterVectorDestination, QgsProcessingParameterBand, QgsProcessingParameterLayout, QgsProcessingParameterLayoutItem, QgsProcessingParameterColor, QgsProcessingParameterCoordinateOperation, QgsProcessingParameterMapTheme, QgsProcessingParameterProviderConnection, QgsProcessingParameterDatabaseSchema, QgsProcessingParameterDatabaseTable, and QgsProcessingParameterPointCloudAttribute.
Definition at line 2929 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 QgsProcessingParameterAggregate, QgsProcessingParameterAlignRasterLayers, QgsProcessingParameterDxfLayers, QgsProcessingParameterFieldMapping, QgsProcessingParameterMeshDatasetGroups, QgsProcessingParameterMeshDatasetTime, QgsProcessingParameterCrs, QgsProcessingParameterExtent, QgsProcessingParameterPoint, QgsProcessingParameterGeometry, QgsProcessingParameterFile, QgsProcessingParameterMatrix, QgsProcessingParameterMultipleLayers, QgsProcessingParameterNumber, QgsProcessingParameterRange, QgsProcessingParameterRasterLayer, QgsProcessingParameterEnum, QgsProcessingParameterVectorLayer, QgsProcessingParameterMeshLayer, QgsProcessingParameterMapLayer, QgsProcessingParameterField, QgsProcessingParameterFeatureSource, QgsProcessingParameterFeatureSink, QgsProcessingParameterVectorDestination, QgsProcessingParameterRasterDestination, QgsProcessingParameterFileDestination, QgsProcessingParameterFolderDestination, QgsProcessingParameterBand, QgsProcessingParameterColor, QgsProcessingParameterMapTheme, QgsProcessingParameterDateTime, QgsProcessingParameterProviderConnection, QgsProcessingParameterDatabaseSchema, QgsProcessingParameterDatabaseTable, QgsProcessingParameterPointCloudLayer, QgsProcessingParameterAnnotationLayer, QgsProcessingParameterPointCloudDestination, QgsProcessingParameterPointCloudAttribute, QgsProcessingParameterVectorTileDestination, QgsProcessingParameterTinInputLayers, and QgsProcessingParameterVectorTileWriterLayers.
Definition at line 2495 of file qgsprocessingparameters.cpp.
|
pure virtual |
Creates a clone of the parameter definition.
Implemented in QgsProcessingParameterAggregate, QgsProcessingParameterAlignRasterLayers, QgsProcessingParameterDxfLayers, QgsProcessingParameterFieldMapping, QgsProcessingParameterMeshDatasetGroups, QgsProcessingParameterMeshDatasetTime, QgsProcessingParameterBoolean, QgsProcessingParameterCrs, QgsProcessingParameterExtent, QgsProcessingParameterPoint, QgsProcessingParameterGeometry, QgsProcessingParameterFile, QgsProcessingParameterMatrix, QgsProcessingParameterMultipleLayers, QgsProcessingParameterNumber, QgsProcessingParameterDistance, QgsProcessingParameterArea, QgsProcessingParameterVolume, QgsProcessingParameterDuration, QgsProcessingParameterScale, QgsProcessingParameterRange, QgsProcessingParameterRasterLayer, QgsProcessingParameterEnum, QgsProcessingParameterString, QgsProcessingParameterAuthConfig, QgsProcessingParameterExpression, QgsProcessingParameterVectorLayer, QgsProcessingParameterMeshLayer, QgsProcessingParameterMapLayer, QgsProcessingParameterField, QgsProcessingParameterFeatureSource, QgsProcessingParameterFeatureSink, QgsProcessingParameterVectorDestination, QgsProcessingParameterRasterDestination, QgsProcessingParameterFileDestination, QgsProcessingParameterFolderDestination, QgsProcessingParameterBand, QgsProcessingParameterLayout, QgsProcessingParameterLayoutItem, QgsProcessingParameterColor, QgsProcessingParameterCoordinateOperation, QgsProcessingParameterMapTheme, QgsProcessingParameterDateTime, QgsProcessingParameterProviderConnection, QgsProcessingParameterDatabaseSchema, QgsProcessingParameterDatabaseTable, QgsProcessingParameterPointCloudLayer, QgsProcessingParameterAnnotationLayer, QgsProcessingParameterPointCloudDestination, QgsProcessingParameterPointCloudAttribute, QgsProcessingParameterVectorTileDestination, QgsProcessingParameterTinInputLayers, and QgsProcessingParameterVectorTileWriterLayers.
|
protected |
Default gui value for an algorithm parameter from settings.
Definition at line 2481 of file qgsprocessingparameters.cpp.
|
inline |
Returns the default value for the parameter.
Definition at line 536 of file qgsprocessingparameters.h.
QVariant QgsProcessingParameterDefinition::defaultValueForGui | ( | ) | const |
Returns the default value to use for the parameter in a GUI.
This will be the parameter's defaultValue(), unless a guiDefaultValueOverride() is set to override that.
Definition at line 2471 of file qgsprocessingparameters.cpp.
|
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 QgsProcessingParameterAggregate, QgsProcessingParameterFieldMapping, QgsProcessingParameterMeshDatasetGroups, QgsProcessingParameterMeshDatasetTime, QgsProcessingParameterDistance, QgsProcessingParameterArea, QgsProcessingParameterVolume, QgsProcessingParameterExpression, QgsProcessingParameterField, QgsProcessingParameterBand, QgsProcessingParameterLayoutItem, QgsProcessingParameterCoordinateOperation, QgsProcessingParameterDatabaseSchema, QgsProcessingParameterDatabaseTable, and QgsProcessingParameterPointCloudAttribute.
Definition at line 724 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 499 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 791 of file qgsprocessingparameters.h.
|
inline |
Returns the property definition for dynamic properties.
Definition at line 770 of file qgsprocessingparameters.h.
|
inline |
Returns any flags associated with the parameter.
Definition at line 591 of file qgsprocessingparameters.h.
|
virtual |
Restores this parameter to a QVariantMap.
Subclasses should ensure that they call the base class method.
Reimplemented in QgsProcessingParameterAggregate, QgsProcessingParameterFieldMapping, QgsProcessingParameterMeshDatasetGroups, QgsProcessingParameterMeshDatasetTime, QgsProcessingParameterGeometry, QgsProcessingParameterFile, QgsProcessingParameterMatrix, QgsProcessingParameterMultipleLayers, QgsProcessingParameterNumber, QgsProcessingParameterDistance, QgsProcessingParameterArea, QgsProcessingParameterVolume, QgsProcessingParameterDuration, QgsProcessingParameterRange, QgsProcessingParameterEnum, QgsProcessingParameterString, QgsProcessingParameterExpression, QgsProcessingParameterVectorLayer, QgsProcessingParameterMapLayer, QgsProcessingParameterField, QgsProcessingParameterFeatureSource, QgsProcessingDestinationParameter, QgsProcessingParameterFeatureSink, QgsProcessingParameterVectorDestination, QgsProcessingParameterFileDestination, QgsProcessingParameterBand, QgsProcessingParameterLayoutItem, QgsProcessingParameterColor, QgsProcessingParameterCoordinateOperation, QgsProcessingParameterMapTheme, QgsProcessingParameterDateTime, QgsProcessingParameterProviderConnection, QgsProcessingParameterDatabaseSchema, QgsProcessingParameterDatabaseTable, and QgsProcessingParameterPointCloudAttribute.
Definition at line 2978 of file qgsprocessingparameters.cpp.
QVariant QgsProcessingParameterDefinition::guiDefaultValueOverride | ( | ) | const |
Returns the default value to use in the GUI for the parameter.
Usually this will return an invalid variant, which indicates that the standard defaultValue() will be used in the GUI.
Definition at line 2461 of file qgsprocessingparameters.cpp.
|
inline |
Returns the help for the parameter.
This is a descriptive (possibly lengthy), translated string explaining the parameter's behavior and use in depth.
Definition at line 517 of file qgsprocessingparameters.h.
|
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 478 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 753 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 711 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 704 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 485 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 2995 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 838 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 544 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 506 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 804 of file qgsprocessingparameters.h.
|
inline |
Sets the property definition for dynamic properties.
Definition at line 778 of file qgsprocessingparameters.h.
|
inline |
Sets the flags associated with the parameter.
Definition at line 597 of file qgsprocessingparameters.h.
|
inline |
Sets the default value to use for the parameter in GUI widgets.
Caller takes responsibility to ensure that value is a valid input for the parameter subclass.
Usually the guiDefaultValueOverride() is a invalid variant, which indicates that the standard defaultValue() should be used in the GUI. In cases where it is decided that a previous default value was inappropriate, setting a non-invalid default GUI value can be used to change the default value for the parameter shown to users when running algorithms without changing the actual defaultValue() and potentially breaking third party scripts.
Definition at line 575 of file qgsprocessingparameters.h.
|
inline |
Sets the help for the parameter.
The help string should be a descriptive, translated string explaining the parameter's behavior and use in depth.
Definition at line 528 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 762 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 718 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 492 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, and QgsProcessingParameterDateTime.
Definition at line 3000 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 QgsProcessingParameterAggregate, QgsProcessingParameterFieldMapping, QgsProcessingParameterMeshDatasetGroups, QgsProcessingParameterMeshDatasetTime, QgsProcessingParameterGeometry, QgsProcessingParameterFile, QgsProcessingParameterMatrix, QgsProcessingParameterMultipleLayers, QgsProcessingParameterNumber, QgsProcessingParameterDistance, QgsProcessingParameterArea, QgsProcessingParameterVolume, QgsProcessingParameterDuration, QgsProcessingParameterRange, QgsProcessingParameterEnum, QgsProcessingParameterString, QgsProcessingParameterExpression, QgsProcessingParameterVectorLayer, QgsProcessingParameterMapLayer, QgsProcessingParameterField, QgsProcessingParameterFeatureSource, QgsProcessingDestinationParameter, QgsProcessingParameterFeatureSink, QgsProcessingParameterVectorDestination, QgsProcessingParameterFileDestination, QgsProcessingParameterBand, QgsProcessingParameterLayoutItem, QgsProcessingParameterColor, QgsProcessingParameterCoordinateOperation, QgsProcessingParameterMapTheme, QgsProcessingParameterDateTime, QgsProcessingParameterProviderConnection, QgsProcessingParameterDatabaseSchema, QgsProcessingParameterDatabaseTable, and QgsProcessingParameterPointCloudAttribute.
Definition at line 2964 of file qgsprocessingparameters.cpp.
|
pure virtual |
Unique parameter type name.
Implemented in QgsProcessingParameterAggregate, QgsProcessingParameterAlignRasterLayers, QgsProcessingParameterDxfLayers, QgsProcessingParameterFieldMapping, QgsProcessingParameterMeshDatasetGroups, QgsProcessingParameterMeshDatasetTime, QgsProcessingParameterBoolean, QgsProcessingParameterCrs, QgsProcessingParameterExtent, QgsProcessingParameterPoint, QgsProcessingParameterGeometry, QgsProcessingParameterFile, QgsProcessingParameterMatrix, QgsProcessingParameterMultipleLayers, QgsProcessingParameterNumber, QgsProcessingParameterDistance, QgsProcessingParameterArea, QgsProcessingParameterVolume, QgsProcessingParameterDuration, QgsProcessingParameterScale, QgsProcessingParameterRange, QgsProcessingParameterRasterLayer, QgsProcessingParameterEnum, QgsProcessingParameterString, QgsProcessingParameterAuthConfig, QgsProcessingParameterExpression, QgsProcessingParameterVectorLayer, QgsProcessingParameterMeshLayer, QgsProcessingParameterMapLayer, QgsProcessingParameterField, QgsProcessingParameterFeatureSource, QgsProcessingParameterFeatureSink, QgsProcessingParameterVectorDestination, QgsProcessingParameterRasterDestination, QgsProcessingParameterFileDestination, QgsProcessingParameterFolderDestination, QgsProcessingParameterBand, QgsProcessingParameterLayout, QgsProcessingParameterLayoutItem, QgsProcessingParameterColor, QgsProcessingParameterCoordinateOperation, QgsProcessingParameterMapTheme, QgsProcessingParameterDateTime, QgsProcessingParameterProviderConnection, QgsProcessingParameterDatabaseSchema, QgsProcessingParameterDatabaseTable, QgsProcessingParameterPointCloudLayer, QgsProcessingParameterAnnotationLayer, QgsProcessingParameterPointCloudDestination, QgsProcessingParameterPointCloudAttribute, QgsProcessingParameterVectorTileDestination, QgsProcessingParameterTinInputLayers, and QgsProcessingParameterVectorTileWriterLayers.
|
virtual |
Returns a version of the parameter input value, which is suitable for use in a JSON object.
This method must return only simple values which can be losslessly encapsulated in a serialized JSON map. For instance, any QGIS class values (such as QgsCoordinateReferenceSystem) must be converted to a simple string or numeric value equivalent.
Reimplemented in QgsProcessingParameterAlignRasterLayers, QgsProcessingParameterDxfLayers, QgsProcessingParameterCrs, QgsProcessingParameterExtent, QgsProcessingParameterMultipleLayers, QgsProcessingParameterRasterLayer, QgsProcessingParameterVectorLayer, QgsProcessingParameterMeshLayer, QgsProcessingParameterMapLayer, QgsProcessingParameterFeatureSource, QgsProcessingParameterPointCloudLayer, QgsProcessingParameterAnnotationLayer, and QgsProcessingParameterTinInputLayers.
Definition at line 2518 of file qgsprocessingparameters.cpp.
|
protected |
Internal method for evaluating values as JSON objects.
Definition at line 2523 of file qgsprocessingparameters.cpp.
|
virtual |
Returns a Python comment explaining a parameter value, or an empty string if no comment is required.
Reimplemented in QgsProcessingParameterEnum.
Definition at line 2924 of file qgsprocessingparameters.cpp.
|
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 QgsProcessingParameterAggregate, QgsProcessingParameterAlignRasterLayers, QgsProcessingParameterDxfLayers, QgsProcessingParameterFieldMapping, QgsProcessingParameterMeshDatasetGroups, QgsProcessingParameterMeshDatasetTime, QgsProcessingParameterBoolean, QgsProcessingParameterCrs, QgsProcessingParameterExtent, QgsProcessingParameterPoint, QgsProcessingParameterGeometry, QgsProcessingParameterMatrix, QgsProcessingParameterMultipleLayers, QgsProcessingParameterNumber, QgsProcessingParameterRange, QgsProcessingParameterRasterLayer, QgsProcessingParameterEnum, QgsProcessingParameterString, QgsProcessingParameterAuthConfig, QgsProcessingParameterExpression, QgsProcessingParameterVectorLayer, QgsProcessingParameterMeshLayer, QgsProcessingParameterMapLayer, QgsProcessingParameterField, QgsProcessingParameterFeatureSource, QgsProcessingParameterFeatureSink, QgsProcessingParameterVectorDestination, QgsProcessingParameterRasterDestination, QgsProcessingParameterFileDestination, QgsProcessingParameterBand, QgsProcessingParameterLayout, QgsProcessingParameterLayoutItem, QgsProcessingParameterColor, QgsProcessingParameterCoordinateOperation, QgsProcessingParameterMapTheme, QgsProcessingParameterDateTime, QgsProcessingParameterProviderConnection, QgsProcessingParameterDatabaseSchema, QgsProcessingParameterDatabaseTable, QgsProcessingParameterPointCloudLayer, QgsProcessingParameterAnnotationLayer, QgsProcessingParameterPointCloudDestination, QgsProcessingParameterPointCloudAttribute, QgsProcessingParameterVectorTileDestination, QgsProcessingParameterTinInputLayers, and QgsProcessingParameterVectorTileWriterLayers.
Definition at line 2507 of file qgsprocessingparameters.cpp.
|
virtual |
Returns a string version of the parameter input value (if possible).
value | value to convert |
context | processing context |
ok | will be set to true if value could be represented as a string. |
Reimplemented in QgsProcessingParameterAlignRasterLayers, QgsProcessingParameterDxfLayers, QgsProcessingParameterCrs, QgsProcessingParameterExtent, QgsProcessingParameterMultipleLayers, QgsProcessingParameterRasterLayer, QgsProcessingParameterVectorLayer, QgsProcessingParameterMeshLayer, QgsProcessingParameterMapLayer, QgsProcessingParameterFeatureSource, QgsProcessingParameterPointCloudLayer, QgsProcessingParameterAnnotationLayer, and QgsProcessingParameterTinInputLayers.
Definition at line 2721 of file qgsprocessingparameters.cpp.
|
virtual |
Returns a string list version of the parameter input value (if possible).
value | value to convert |
context | processing context |
ok | will be set to true if value could be represented as a string list |
Definition at line 2899 of file qgsprocessingparameters.cpp.
|
protected |
Internal method for evaluating values as string.
Definition at line 2726 of file qgsprocessingparameters.cpp.
|
friend |
Definition at line 922 of file qgsprocessingparameters.h.
|
protected |
Additional expression context variables exposed for use by this parameter.
Definition at line 919 of file qgsprocessingparameters.h.
|
protected |
Pointer to algorithm which owns this parameter.
Definition at line 907 of file qgsprocessingparameters.h.
|
protected |
Default value for parameter.
Definition at line 895 of file qgsprocessingparameters.h.
|
protected |
Parameter description.
Definition at line 889 of file qgsprocessingparameters.h.
|
protected |
Linked vector layer parameter name for dynamic properties.
Definition at line 916 of file qgsprocessingparameters.h.
|
protected |
Parameter flags.
Definition at line 901 of file qgsprocessingparameters.h.
|
protected |
Default value for parameter in GUI.
Definition at line 898 of file qgsprocessingparameters.h.
|
protected |
Parameter help.
Definition at line 892 of file qgsprocessingparameters.h.
|
protected |
True for dynamic parameters, which can have data-defined (QgsProperty) based values.
Definition at line 910 of file qgsprocessingparameters.h.
|
protected |
Freeform metadata for parameter. Mostly used by widget wrappers to customize their appearance and behavior.
Definition at line 904 of file qgsprocessingparameters.h.
|
protected |
Parameter name.
Definition at line 886 of file qgsprocessingparameters.h.
|
protected |
Data defined property definition.
Definition at line 913 of file qgsprocessingparameters.h.