QgsProcessingOutputDefinition class

Base class for the definition of processing outputs.

Contents

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

Derived classes

class QgsProcessingOutputFile
A file output for processing algorithms.
class QgsProcessingOutputFolder
A folder output for processing algorithms.
class QgsProcessingOutputHtml
A HTML file output for processing algorithms.
class QgsProcessingOutputMapLayer
A map layer output for processing algorithms, where layers may be either vector or raster.
class QgsProcessingOutputMultipleLayers
A multi-layer output for processing algorithms which create map layers, when the number and nature of the output layers is not predefined.
class QgsProcessingOutputNumber
A numeric output for processing algorithms.
class QgsProcessingOutputRasterLayer
A raster layer output for processing algorithms.
class QgsProcessingOutputString
A string output for processing algorithms.
class QgsProcessingOutputVectorLayer
A vector layer output for processing algorithms.

Constructors, destructors, conversion operators

QgsProcessingOutputDefinition(const QString& name, const QString& description = QString())
Constructor for QgsProcessingOutputDefinition.

Public functions

auto description() const -> QString
Returns the description for the output.
auto name() const -> QString
Returns the name of the output.
void setDescription(const QString& description)
Sets the description for the output.
void setName(const QString& name)
Sets the name of the output.
auto type() const -> QString pure virtual
Unique output type name.

Protected variables

QString mDescription
Output description.
QString mName
Output name.

Function documentation

QString QgsProcessingOutputDefinition::description() const

Returns the description for the output.

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

QString QgsProcessingOutputDefinition::name() const

Returns the name of the output.

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

void QgsProcessingOutputDefinition::setDescription(const QString& description)

Sets the description for the output.

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

void QgsProcessingOutputDefinition::setName(const QString& name)

Sets the name of the output.

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