QgsProcessingOutputMapLayer Class Reference

A map layer output for processing algorithms, where layers may be either vector or raster. More...

#include <qgsprocessingoutputs.h>

Inheritance diagram for QgsProcessingOutputMapLayer:

Public Member Functions
	QgsProcessingOutputMapLayer (const QString &name, const QString &description=QString())
	Constructor for QgsProcessingOutputMapLayer.
QColor	modelColor () const override
	Returns the color to use for the output in the model designer canvas.
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 map layer output for processing algorithms, where layers may be either vector or raster.

If the actual layer output type is known (e.g. always vector or always raster), use QgsProcessingOutputVectorLayer or QgsProcessingOutputRasterLayer instead.

Definition at line 198 of file qgsprocessingoutputs.h.

Constructor & Destructor Documentation

QgsProcessingOutputMapLayer()

QgsProcessingOutputMapLayer::QgsProcessingOutputMapLayer	(	const QString &	name,
		const QString &	description = QString() )

Constructor for QgsProcessingOutputMapLayer.

Definition at line 215 of file qgsprocessingoutputs.cpp.

Member Function Documentation

modelColor()

QColor QgsProcessingOutputMapLayer::modelColor ( ) const

overridevirtual

Returns the color to use for the output in the model designer canvas.

Since

QGIS 4.0

Reimplemented from QgsProcessingOutputDefinition.

Definition at line 224 of file qgsprocessingoutputs.cpp.

type()

QString QgsProcessingOutputMapLayer::type ( ) const

overridevirtual

Unique output type name.

Implements QgsProcessingOutputDefinition.

Definition at line 219 of file qgsprocessingoutputs.cpp.

typeName()

QString QgsProcessingOutputMapLayer::typeName ( )

inlinestatic

Returns the type name for the output class.

Definition at line 212 of file qgsprocessingoutputs.h.

---

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

• /build/qgis-3.99.0+git20251210+2fe06baccd8+99sid/src/core/processing/qgsprocessingoutputs.h
• /build/qgis-3.99.0+git20251210+2fe06baccd8+99sid/src/core/processing/qgsprocessingoutputs.cpp