A vector layer output for processing algorithms. More...

#include <qgsprocessingoutputs.h>

Inheritance diagram for QgsProcessingOutputVectorLayer:

Public Member Functions
	QgsProcessingOutputVectorLayer (const QString &name, const QString &description=QString(), Qgis::ProcessingSourceType type=Qgis::ProcessingSourceType::VectorAnyGeometry)
	Constructor for QgsProcessingOutputVectorLayer.

Qgis::ProcessingSourceType	dataType () const
	Returns the layer type for the output layer.

void	setDataType (Qgis::ProcessingSourceType type)
	Sets the layer type for the output layer.

QString	type () const override
	Unique output type name.

Public Member Functions inherited from QgsProcessingOutputDefinition
	QgsProcessingOutputDefinition (const QString &name, const QString &description=QString())
	Constructor for QgsProcessingOutputDefinition.

virtual	~QgsProcessingOutputDefinition ()=default

bool	autoCreated () const
	Returns `true` if the output was automatically created when adding a parameter.

QString	description () const
	Returns the description for the output.

QString	name () const
	Returns the name of the output.

void	setAutoCreated (bool autoCreated)
	Sets whether an output was automatically created when adding a parameter.

void	setDescription (const QString &description)
	Sets the description for the output.

void	setName (const QString &name)
	Sets the name of the output.

virtual QString	valueAsFormattedString (const QVariant &value, QgsProcessingContext &context, bool &ok) const
	Returns a HTML string version of the parameter output value (if possible).

virtual QString	valueAsString (const QVariant &value, QgsProcessingContext &context, bool &ok) const
	Returns a string version of the parameter output value (if possible).

Static Public Member Functions
static QString	typeName ()
	Returns the type name for the output class.

Additional Inherited Members
Protected Attributes inherited from QgsProcessingOutputDefinition
bool	mAutoCreated = false

QString	mDescription
	Output description.

QString	mName
	Output name.

Detailed Description

A vector layer output for processing algorithms.

Definition at line 212 of file qgsprocessingoutputs.h.

Constructor & Destructor Documentation

◆ QgsProcessingOutputVectorLayer()

QgsProcessingOutputVectorLayer::QgsProcessingOutputVectorLayer	(	const QString &	name,
		const QString &	description = `QString()`,
		Qgis::ProcessingSourceType	type = `Qgis::ProcessingSourceType::VectorAnyGeometry`
	)

Constructor for QgsProcessingOutputVectorLayer.

Definition at line 51 of file qgsprocessingoutputs.cpp.

Member Function Documentation

◆ dataType()

Qgis::ProcessingSourceType QgsProcessingOutputVectorLayer::dataType ( ) const

Returns the layer type for the output layer.

See also: setDataType()

Definition at line 56 of file qgsprocessingoutputs.cpp.

◆ setDataType()

void QgsProcessingOutputVectorLayer::setDataType ( Qgis::ProcessingSourceType type )

Sets the layer type for the output layer.

See also: dataType()

Definition at line 61 of file qgsprocessingoutputs.cpp.

◆ type()

QString QgsProcessingOutputVectorLayer::type ( ) const

inlineoverridevirtual

Unique output type name.

Implements QgsProcessingOutputDefinition.

Definition at line 225 of file qgsprocessingoutputs.h.

◆ typeName()

static QString QgsProcessingOutputVectorLayer::typeName ( )

inlinestatic

Returns the type name for the output class.

Definition at line 224 of file qgsprocessingoutputs.h.

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

/build/qgis-3.41.0+git20241110+fda2aa46e9a+99sid/src/core/processing/qgsprocessingoutputs.h
/build/qgis-3.41.0+git20241110+fda2aa46e9a+99sid/src/core/processing/qgsprocessingoutputs.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members