QGIS API Documentation
3.0.2-Girona (307d082)
|
Base class for all parameter definitions which represent file or layer destinations, e.g. More...
#include <qgsprocessingparameters.h>
Public Member Functions | |
QgsProcessingDestinationParameter (const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false) | |
Constructor for QgsProcessingDestinationParameter. More... | |
bool | createByDefault () const |
Returns true if the destination should be created by default. More... | |
virtual QString | defaultFileExtension () const =0 |
Returns the default file extension for destination file paths associated with this parameter. More... | |
bool | fromVariantMap (const QVariantMap &map) override |
Restores this parameter to a QVariantMap. More... | |
virtual QString | generateTemporaryDestination () const |
Generates a temporary destination value for this parameter. More... | |
bool | isDestination () const override |
Returns true if this parameter represents a file or layer destination, e.g. More... | |
void | setCreateByDefault (bool createByDefault) |
Sets whether the destination should be created by default. More... | |
void | setSupportsNonFileBasedOutput (bool supportsNonFileBasedOutput) |
Sets whether the destination parameter supports non filed-based outputs, such as memory layers or direct database outputs. More... | |
bool | supportsNonFileBasedOutput () const |
Returns true if the destination parameter supports non filed-based outputs, such as memory layers or direct database outputs. More... | |
virtual QgsProcessingOutputDefinition * | toOutputDefinition () const =0 |
Returns a new QgsProcessingOutputDefinition corresponding to the definition of the destination parameter. More... | |
QVariantMap | toVariantMap () const override |
Saves this parameter to a QVariantMap. More... | |
Public Member Functions inherited from QgsProcessingParameterDefinition | |
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... | |
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 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... | |
Additional Inherited Members | |
Public Types inherited from QgsProcessingParameterDefinition | |
enum | Flag { FlagAdvanced = 1 << 1, FlagHidden = 1 << 2, FlagOptional = 1 << 3 } |
Parameter flags. More... | |
Protected Attributes inherited from QgsProcessingParameterDefinition | |
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... | |
Base class for all parameter definitions which represent file or layer destinations, e.g.
parameters which are used for the destination for layers output by an algorithm.
Definition at line 1700 of file qgsprocessingparameters.h.
QgsProcessingDestinationParameter::QgsProcessingDestinationParameter | ( | const QString & | name, |
const QString & | description = QString() , |
||
const QVariant & | defaultValue = QVariant() , |
||
bool | optional = false |
||
) |
Constructor for QgsProcessingDestinationParameter.
Definition at line 3487 of file qgsprocessingparameters.cpp.
bool QgsProcessingDestinationParameter::createByDefault | ( | ) | const |
Returns true if the destination should be created by default.
For optional parameters, a return value of false indicates that the destination should not be created by default.
Definition at line 3514 of file qgsprocessingparameters.cpp.
|
pure virtual |
Returns the default file extension for destination file paths associated with this parameter.
Implemented in QgsProcessingParameterFolderDestination, QgsProcessingParameterFileDestination, QgsProcessingParameterRasterDestination, QgsProcessingParameterVectorDestination, and QgsProcessingParameterFeatureSink.
|
overridevirtual |
Restores this parameter to a QVariantMap.
Subclasses should ensure that they call the base class method.
Reimplemented from QgsProcessingParameterDefinition.
Reimplemented in QgsProcessingParameterFileDestination, QgsProcessingParameterVectorDestination, and QgsProcessingParameterFeatureSink.
Definition at line 3501 of file qgsprocessingparameters.cpp.
|
virtual |
Generates a temporary destination value for this parameter.
The returned value will be a file path or QGIS data provider URI suitable for temporary storage of created layers and files.
Reimplemented in QgsProcessingParameterFeatureSink.
Definition at line 3509 of file qgsprocessingparameters.cpp.
|
inlineoverridevirtual |
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 from QgsProcessingParameterDefinition.
Definition at line 1710 of file qgsprocessingparameters.h.
void QgsProcessingDestinationParameter::setCreateByDefault | ( | bool | createByDefault | ) |
Sets whether the destination should be created by default.
For optional parameters, a value of false indicates that the destination should not be created by default.
Definition at line 3519 of file qgsprocessingparameters.cpp.
|
inline |
Sets whether the destination parameter supports non filed-based outputs, such as memory layers or direct database outputs.
Definition at line 1732 of file qgsprocessingparameters.h.
|
inline |
Returns true if the destination parameter supports non filed-based outputs, such as memory layers or direct database outputs.
Definition at line 1725 of file qgsprocessingparameters.h.
|
pure virtual |
Returns a new QgsProcessingOutputDefinition corresponding to the definition of the destination parameter.
Implemented in QgsProcessingParameterFolderDestination, QgsProcessingParameterFileDestination, QgsProcessingParameterRasterDestination, QgsProcessingParameterVectorDestination, and QgsProcessingParameterFeatureSink.
|
overridevirtual |
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 from QgsProcessingParameterDefinition.
Reimplemented in QgsProcessingParameterFileDestination, QgsProcessingParameterVectorDestination, and QgsProcessingParameterFeatureSink.
Definition at line 3493 of file qgsprocessingparameters.cpp.