QgsProcessingOutputDefinition Class Reference

Base class for the definition of processing outputs. More...

#include <qgsprocessingoutputs.h>

Inheritance diagram for QgsProcessingOutputDefinition:

Public Member Functions
	QgsProcessingOutputDefinition (const QString &name, const QString &description=QString())
	Constructor for QgsProcessingOutputDefinition. More...
virtual	~QgsProcessingOutputDefinition ()=default
QString	description () const
	Returns the description for the output. More...
QString	name () const
	Returns the name of the output. More...
void	setDescription (const QString &description)
	Sets the description for the output. More...
void	setName (const QString &name)
	Sets the name of the output. More...
virtual QString	type () const =0
	Unique output type name. More...

Protected Attributes
QString	mDescription
	Output description. More...
QString	mName
	Output name. More...

Detailed Description

Base class for the definition of processing outputs.

Output definitions encapsulate the properties regarding the outputs from algorithms, such as generated layers or calculated values.

Since

QGIS 3.0

Definition at line 41 of file qgsprocessingoutputs.h.

Constructor & Destructor Documentation

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

Constructor for QgsProcessingOutputDefinition.

Definition at line 20 of file qgsprocessingoutputs.cpp.

virtual QgsProcessingOutputDefinition::~QgsProcessingOutputDefinition ( )

virtualdefault

Member Function Documentation

QString QgsProcessingOutputDefinition::description ( ) const

inline

Returns the description for the output.

This is the user-visible string used to identify this output.

See also

setDescription()

Definition at line 102 of file qgsprocessingoutputs.h.

QString QgsProcessingOutputDefinition::name ( ) const

inline

Returns the name of the output.

This is the internal identifier by which algorithms access this output.

See also

setName()

Definition at line 88 of file qgsprocessingoutputs.h.

void QgsProcessingOutputDefinition::setDescription ( const QString &  description )

inline

Sets the description for the output.

This is the user-visible string used to identify this output.

See also

description()

Definition at line 109 of file qgsprocessingoutputs.h.

void QgsProcessingOutputDefinition::setName ( const QString &  name )

inline

Sets the name of the output.

This is the internal identifier by which algorithms access this output.

See also

name()

Definition at line 95 of file qgsprocessingoutputs.h.

virtual QString QgsProcessingOutputDefinition::type ( ) const

pure virtual

Unique output type name.

Implemented in QgsProcessingOutputFile, QgsProcessingOutputFolder, QgsProcessingOutputString, QgsProcessingOutputNumber, QgsProcessingOutputHtml, QgsProcessingOutputMultipleLayers, QgsProcessingOutputRasterLayer, QgsProcessingOutputVectorLayer, and QgsProcessingOutputMapLayer.

Member Data Documentation

QString QgsProcessingOutputDefinition::mDescription

protected

Output description.

Definition at line 117 of file qgsprocessingoutputs.h.

QString QgsProcessingOutputDefinition::mName

protected

Output name.

Definition at line 114 of file qgsprocessingoutputs.h.

---

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

• /build/qgis-3.4.15+24xenial/src/core/processing/qgsprocessingoutputs.h
• /build/qgis-3.4.15+24xenial/src/core/processing/qgsprocessingoutputs.cpp