QgsProcessingParameterVectorDestination class

A vector layer destination parameter, for specifying the destination path for a vector layer created by the algorithm.

Reference

Base classes

class QgsProcessingDestinationParameter: Base class for all parameter definitions which represent file or layer destinations, e.g.

Public static functions

static auto fromScriptCode(const QString& name, const QString& description, bool isOptional, const QString& definition) -> QgsProcessingParameterVectorDestination*: Creates a new parameter using the definition from a script code.
static auto typeName() -> QString: Returns the type name for the parameter class.

Constructors, destructors, conversion operators

QgsProcessingParameterVectorDestination(const QString& name, const QString& description = QString(), QgsProcessing::SourceType type = QgsProcessing::TypeVectorAnyGeometry, const QVariant& defaultValue = QVariant(), bool optional = false, bool createByDefault = true): Constructor for QgsProcessingParameterVectorDestination.

Public functions

auto asScriptCode() const -> QString override: Returns the parameter definition encoded in a string which can be used within a Python processing script.
auto checkValueIsAcceptable(const QVariant& input, QgsProcessingContext* context = nullptr) const -> bool override: Checks whether the specified input value is acceptable for the parameter.
auto clone() const -> QgsProcessingParameterDefinition* override: Creates a clone of the parameter definition.
auto dataType() const -> QgsProcessing::SourceType: Returns the layer type for this created vector layer.
auto defaultFileExtension() const -> QString override: Returns the default file extension for destination file paths associated with this parameter.
auto fromVariantMap(const QVariantMap& map) -> bool override: Restores this parameter to a QVariantMap.
auto hasGeometry() const -> bool: Returns true if the created layer is likely to include geometries.
void setDataType(QgsProcessing::SourceType type): Sets the layer type for the created vector layer.
auto supportedOutputVectorLayerExtensions() const -> QStringList virtual: Returns a list of the vector format file extensions supported by this parameter.
auto toOutputDefinition() const -> QgsProcessingOutputDefinition* override: Returns a new QgsProcessingOutputDefinition corresponding to the definition of the destination parameter.
auto toVariantMap() const -> QVariantMap override: Saves this parameter to a QVariantMap.
auto type() const -> QString override: Unique parameter type name.
auto valueAsPythonString(const QVariant& value, QgsProcessingContext& context) const -> QString 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.

Function documentation

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

Constructor for QgsProcessingParameterVectorDestination.

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

bool QgsProcessingParameterVectorDestination::checkValueIsAcceptable(const QVariant& input, QgsProcessingContext* context = nullptr) const override

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.

QgsProcessing::SourceType QgsProcessingParameterVectorDestination::dataType() const

Returns the layer type for this created vector layer.

bool QgsProcessingParameterVectorDestination::fromVariantMap(const QVariantMap& map) override

Restores this parameter to a QVariantMap.

Subclasses should ensure that they call the base class method.

bool QgsProcessingParameterVectorDestination::hasGeometry() const

Returns true if the created layer is likely to include geometries.

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

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

Sets the layer type for the created vector layer.

QStringList QgsProcessingParameterVectorDestination::supportedOutputVectorLayerExtensions() const virtual

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

QVariantMap QgsProcessingParameterVectorDestination::toVariantMap() const override

Saves this parameter to a QVariantMap.

Subclasses should ensure that they call the base class method and then extend the result with additional properties.

QString QgsProcessingParameterVectorDestination::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.

The returned value must be correctly escaped - e.g. string values must be wrapped in ' 's.