QgsProcessingOutputConditionalBranch Class Reference

A conditional branch output for processing algorithms, which represents a possible model logic flow which branches out from this algorithm. More...

#include <qgsprocessingoutputs.h>

Inheritance diagram for QgsProcessingOutputConditionalBranch:

Public Member Functions
	QgsProcessingOutputConditionalBranch (const QString &name, const QString &description=QString())
	Constructor for QgsProcessingOutputConditionalBranch.
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 conditional branch output for processing algorithms, which represents a possible model logic flow which branches out from this algorithm.

Since

QGIS 3.14

Definition at line 485 of file qgsprocessingoutputs.h.

Constructor & Destructor Documentation

QgsProcessingOutputConditionalBranch()

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

Constructor for QgsProcessingOutputConditionalBranch.

Definition at line 213 of file qgsprocessingoutputs.cpp.

Member Function Documentation

type()

QString QgsProcessingOutputConditionalBranch::type ( ) const

inlineoverridevirtual

Unique output type name.

Implements QgsProcessingOutputDefinition.

Definition at line 498 of file qgsprocessingoutputs.h.

typeName()

static QString QgsProcessingOutputConditionalBranch::typeName ( )

inlinestatic

Returns the type name for the output class.

Definition at line 497 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