QGIS API Documentation 3.28.0-Firenze (ed3ad0430f)
Public Member Functions | Static Public Member Functions | List of all members
QgsProcessingParameterFeatureSink Class Reference

A feature sink output for processing algorithms. More...

#include <qgsprocessingparameters.h>

Inheritance diagram for QgsProcessingParameterFeatureSink:
Inheritance graph
[legend]

Public Member Functions

 QgsProcessingParameterFeatureSink (const QString &name, const QString &description=QString(), QgsProcessing::SourceType type=QgsProcessing::TypeVectorAnyGeometry, const QVariant &defaultValue=QVariant(), bool optional=false, bool createByDefault=true, bool supportsAppend=false)
 Constructor for QgsProcessingParameterFeatureSink. More...
 
QString asPythonString (QgsProcessing::PythonOutputType outputType=QgsProcessing::PythonQgsProcessingAlgorithmSubclass) const override
 Returns the parameter definition as a Python command which can be used within a Python Processing script. More...
 
QString asScriptCode () const override
 Returns the parameter definition encoded in a string which can be used within a Processing script. More...
 
bool checkValueIsAcceptable (const QVariant &input, QgsProcessingContext *context=nullptr) const override
 Checks whether the specified input value is acceptable for the parameter. More...
 
QgsProcessingParameterDefinitionclone () const override
 Creates a clone of the parameter definition. More...
 
QString createFileFilter () const override
 This method needs to be reimplemented in all classes which implement this interface and return a file filter. More...
 
QgsProcessing::SourceType dataType () const
 Returns the layer type for sinks associated with the parameter. More...
 
QString defaultFileExtension () const override
 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...
 
QString generateTemporaryDestination () const override
 Generates a temporary destination value for this parameter. More...
 
bool hasGeometry () const
 Returns true if sink is likely to include geometries. More...
 
void setDataType (QgsProcessing::SourceType type)
 Sets the layer type for the sinks associated with the parameter. More...
 
void setSupportsAppend (bool supportsAppend)
 Sets whether the sink supports appending features to an existing table. More...
 
virtual QStringList supportedOutputVectorLayerExtensions () const
 Returns a list of the vector format file extensions supported by this parameter. More...
 
bool supportsAppend () const
 Returns true if the sink supports appending features to an existing table. More...
 
QgsProcessingOutputDefinitiontoOutputDefinition () const override
 Returns a new QgsProcessingOutputDefinition corresponding to the definition of the destination parameter. More...
 
QVariantMap toVariantMap () const override
 Saves this parameter to a QVariantMap. More...
 
QString type () const override
 Unique parameter type name. More...
 
QString valueAsPythonString (const QVariant &value, QgsProcessingContext &context) const override
 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...
 
- Public Member Functions inherited from QgsProcessingDestinationParameter
 QgsProcessingDestinationParameter (const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false, bool createByDefault=true)
 Constructor for QgsProcessingDestinationParameter. More...
 
QString asPythonString (QgsProcessing::PythonOutputType outputType=QgsProcessing::PythonQgsProcessingAlgorithmSubclass) const override
 Returns the parameter definition as a Python command which can be used within a Python Processing script. More...
 
bool createByDefault () const
 Returns true if the destination should be created by default. More...
 
QString createFileFilter () const override
 This method needs to be reimplemented in all classes which implement this interface and return a file filter. 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...
 
virtual bool isSupportedOutputValue (const QVariant &value, QgsProcessingContext &context, QString &error) const
 Tests whether a value is a supported value for this parameter. 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 QgsProcessingOutputDefinitiontoOutputDefinition () 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, const QString &help=QString())
 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...
 
QgsProcessingAlgorithmalgorithm () 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 QgsProcessingParameterDefinitionclone () const =0
 Creates a clone of the parameter definition. More...
 
QVariant defaultValue () const
 Returns the default value for the parameter. More...
 
QVariant defaultValueForGui () const
 Returns the default value to use for the parameter in a GUI. 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...
 
QVariant guiDefaultValueOverride () const
 Returns the default value to use in the GUI for the parameter. More...
 
QString help () const
 Returns the help for the parameter. 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 ()
 Returns the parameter's freeform metadata. More...
 
QVariantMap metadata () const
 Returns the parameter's freeform metadata. More...
 
QString name () const
 Returns the name of the parameter. More...
 
QgsProcessingProviderprovider () 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 setGuiDefaultValueOverride (const QVariant &value)
 Sets the default value to use for the parameter in GUI widgets. More...
 
void setHelp (const QString &help)
 Sets the help for 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 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. More...
 
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. 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...
 
virtual QString valueAsString (const QVariant &value, QgsProcessingContext &context, bool &ok) const
 Returns a string version of the parameter input value (if possible). More...
 
virtual QStringList valueAsStringList (const QVariant &value, QgsProcessingContext &context, bool &ok) const
 Returns a string list version of the parameter input value (if possible). More...
 
- Public Member Functions inherited from QgsFileFilterGenerator
virtual ~QgsFileFilterGenerator ()=default
 
virtual QString createFileFilter () const =0
 This method needs to be reimplemented in all classes which implement this interface and return a file filter. More...
 

Static Public Member Functions

static QgsProcessingParameterFeatureSinkfromScriptCode (const QString &name, const QString &description, bool isOptional, const QString &definition)
 Creates a new parameter using the definition from a script code. More...
 
static QString typeName ()
 Returns the type name for the parameter class. More...
 

Additional Inherited Members

- Public Types inherited from QgsProcessingParameterDefinition
enum  Flag { FlagAdvanced = 1 << 1 , FlagHidden = 1 << 2 , FlagOptional = 1 << 3 , FlagIsModelOutput = 1 << 4 }
 Parameter flags. More...
 
enum class  ValueAsStringFlag : int { AllowMapLayerValues = 1 << 0 }
 Flags for passing to the valueAsStringPrivate() method. More...
 
- Protected Member Functions inherited from QgsProcessingDestinationParameter
QgsProcessingProvideroriginalProvider () const
 Original (source) provider which this parameter has been derived from. More...
 
- Protected Member Functions inherited from QgsProcessingParameterDefinition
QVariant valueAsJsonObjectPrivate (const QVariant &value, QgsProcessingContext &context, ValueAsStringFlags flags) const
 Internal method for evaluating values as JSON objects. More...
 
QString valueAsStringPrivate (const QVariant &value, QgsProcessingContext &context, bool &ok, ValueAsStringFlags flags) const
 Internal method for evaluating values as string. More...
 
- Protected Attributes inherited from QgsProcessingParameterDefinition
QStringList mAdditionalExpressionVariables
 Additional expression context variables exposed for use by this parameter. More...
 
QgsProcessingAlgorithmmAlgorithm = 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...
 
QVariant mGuiDefault
 Default value for parameter in GUI. More...
 
QString mHelp
 Parameter help. 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...
 

Detailed Description

A feature sink output for processing algorithms.

A parameter which represents the destination feature sink for features created by an algorithm.

Since
QGIS 3.0

Definition at line 3273 of file qgsprocessingparameters.h.

Constructor & Destructor Documentation

◆ QgsProcessingParameterFeatureSink()

QgsProcessingParameterFeatureSink::QgsProcessingParameterFeatureSink ( const QString &  name,
const QString &  description = QString(),
QgsProcessing::SourceType  type = QgsProcessing::TypeVectorAnyGeometry,
const QVariant &  defaultValue = QVariant(),
bool  optional = false,
bool  createByDefault = true,
bool  supportsAppend = false 
)

Constructor for QgsProcessingParameterFeatureSink.

If createByDefault is false and the parameter is optional, then this destination output will not be created by default.

Definition at line 6192 of file qgsprocessingparameters.cpp.

Member Function Documentation

◆ asPythonString()

QString QgsProcessingParameterFeatureSink::asPythonString ( QgsProcessing::PythonOutputType  outputType = QgsProcessing::PythonQgsProcessingAlgorithmSubclass) const
overridevirtual

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.

Since
QGIS 3.6

Reimplemented from QgsProcessingDestinationParameter.

Definition at line 6323 of file qgsprocessingparameters.cpp.

◆ asScriptCode()

QString QgsProcessingParameterFeatureSink::asScriptCode ( ) const
overridevirtual

Returns the parameter definition encoded in a string which can be used within a Processing script.

Reimplemented from QgsProcessingParameterDefinition.

Definition at line 6262 of file qgsprocessingparameters.cpp.

◆ checkValueIsAcceptable()

bool QgsProcessingParameterFeatureSink::checkValueIsAcceptable ( const QVariant &  input,
QgsProcessingContext context = nullptr 
) const
overridevirtual

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 from QgsProcessingParameterDefinition.

Definition at line 6204 of file qgsprocessingparameters.cpp.

◆ clone()

QgsProcessingParameterDefinition * QgsProcessingParameterFeatureSink::clone ( ) const
overridevirtual

Creates a clone of the parameter definition.

Implements QgsProcessingParameterDefinition.

Definition at line 6199 of file qgsprocessingparameters.cpp.

◆ createFileFilter()

QString QgsProcessingParameterFeatureSink::createFileFilter ( ) const
overridevirtual

This method needs to be reimplemented in all classes which implement this interface and return a file filter.

Reimplemented from QgsProcessingDestinationParameter.

Definition at line 6348 of file qgsprocessingparameters.cpp.

◆ dataType()

QgsProcessing::SourceType QgsProcessingParameterFeatureSink::dataType ( ) const

Returns the layer type for sinks associated with the parameter.

See also
setDataType()

Definition at line 6382 of file qgsprocessingparameters.cpp.

◆ defaultFileExtension()

QString QgsProcessingParameterFeatureSink::defaultFileExtension ( ) const
overridevirtual

Returns the default file extension for destination file paths associated with this parameter.

Implements QgsProcessingDestinationParameter.

Definition at line 6300 of file qgsprocessingparameters.cpp.

◆ fromScriptCode()

QgsProcessingParameterFeatureSink * QgsProcessingParameterFeatureSink::fromScriptCode ( const QString &  name,
const QString &  description,
bool  isOptional,
const QString &  definition 
)
static

Creates a new parameter using the definition from a script code.

Definition at line 6439 of file qgsprocessingparameters.cpp.

◆ fromVariantMap()

bool QgsProcessingParameterFeatureSink::fromVariantMap ( const QVariantMap &  map)
overridevirtual

Restores this parameter to a QVariantMap.

Subclasses should ensure that they call the base class method.

See also
toVariantMap()

Reimplemented from QgsProcessingDestinationParameter.

Definition at line 6423 of file qgsprocessingparameters.cpp.

◆ generateTemporaryDestination()

QString QgsProcessingParameterFeatureSink::generateTemporaryDestination ( ) const
overridevirtual

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 from QgsProcessingDestinationParameter.

Definition at line 6431 of file qgsprocessingparameters.cpp.

◆ hasGeometry()

bool QgsProcessingParameterFeatureSink::hasGeometry ( ) const

Returns true if sink is likely to include geometries.

In cases were presence of geometry cannot be reliably determined in advance, this method will default to returning true.

Definition at line 6387 of file qgsprocessingparameters.cpp.

◆ setDataType()

void QgsProcessingParameterFeatureSink::setDataType ( QgsProcessing::SourceType  type)

Sets the layer type for the sinks associated with the parameter.

See also
dataType()

Definition at line 6410 of file qgsprocessingparameters.cpp.

◆ setSupportsAppend()

void QgsProcessingParameterFeatureSink::setSupportsAppend ( bool  supportsAppend)

Sets whether the sink supports appending features to an existing table.

Warning
A sink only supports appending if the algorithm implements QgsProcessingAlgorithm::sinkProperties for the sink parameter.
See also
supportsAppend()
Since
QGIS 3.14

Definition at line 6472 of file qgsprocessingparameters.cpp.

◆ supportedOutputVectorLayerExtensions()

QStringList QgsProcessingParameterFeatureSink::supportedOutputVectorLayerExtensions ( ) const
virtual

Returns a list of the vector format file extensions supported by this parameter.

See also
defaultFileExtension()
Since
QGIS 3.2

Definition at line 6360 of file qgsprocessingparameters.cpp.

◆ supportsAppend()

bool QgsProcessingParameterFeatureSink::supportsAppend ( ) const

Returns true if the sink supports appending features to an existing table.

A sink only supports appending if the algorithm implements QgsProcessingAlgorithm::sinkProperties for the sink parameter.

See also
setSupportsAppend()
Since
QGIS 3.14

Definition at line 6467 of file qgsprocessingparameters.cpp.

◆ toOutputDefinition()

QgsProcessingOutputDefinition * QgsProcessingParameterFeatureSink::toOutputDefinition ( ) const
overridevirtual

Returns a new QgsProcessingOutputDefinition corresponding to the definition of the destination parameter.

Implements QgsProcessingDestinationParameter.

Definition at line 6295 of file qgsprocessingparameters.cpp.

◆ toVariantMap()

QVariantMap QgsProcessingParameterFeatureSink::toVariantMap ( ) const
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.

See also
fromVariantMap()

Reimplemented from QgsProcessingDestinationParameter.

Definition at line 6415 of file qgsprocessingparameters.cpp.

◆ type()

QString QgsProcessingParameterFeatureSink::type ( ) const
inlineoverridevirtual

Unique parameter type name.

Implements QgsProcessingParameterDefinition.

Definition at line 3291 of file qgsprocessingparameters.h.

◆ typeName()

static QString QgsProcessingParameterFeatureSink::typeName ( )
inlinestatic

Returns the type name for the parameter class.

Definition at line 3289 of file qgsprocessingparameters.h.

◆ valueAsPythonString()

QString QgsProcessingParameterFeatureSink::valueAsPythonString ( const QVariant &  value,
QgsProcessingContext context 
) const
overridevirtual

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.

See also
valueAsJsonObject()
valueAsString()

Reimplemented from QgsProcessingParameterDefinition.

Definition at line 6238 of file qgsprocessingparameters.cpp.


The documentation for this class was generated from the following files: