QGIS API Documentation  3.23.0-Master (eb871beae0)
Public Member Functions | Static Public Member Functions | List of all members
QgsProcessingOutputMultipleLayers Class Reference

A multi-layer output for processing algorithms which create map layers, when the number and nature of the output layers is not predefined. More...

#include <qgsprocessingoutputs.h>

Inheritance diagram for QgsProcessingOutputMultipleLayers:
Inheritance graph
[legend]

Public Member Functions

 QgsProcessingOutputMultipleLayers (const QString &name, const QString &description=QString())
 Constructor for QgsProcessingOutputMultipleLayers. More...
 
QString type () const override
 Unique output type name. More...
 
- Public Member Functions inherited from QgsProcessingOutputDefinition
 QgsProcessingOutputDefinition (const QString &name, const QString &description=QString())
 Constructor for QgsProcessingOutputDefinition. More...
 
virtual ~QgsProcessingOutputDefinition ()=default
 
bool autoCreated () const
 Returns true if the output was automatically created when adding a parameter. More...
 
QString description () const
 Returns the description for the output. More...
 
QString name () const
 Returns the name of the output. More...
 
void setAutoCreated (bool autoCreated)
 Sets whether an output was automatically created when adding a parameter. 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...
 

Static Public Member Functions

static QString typeName ()
 Returns the type name for the output class. More...
 

Additional Inherited Members

- Protected Attributes inherited from QgsProcessingOutputDefinition
bool mAutoCreated = false
 
QString mDescription
 Output description. More...
 
QString mName
 Output name. More...
 

Detailed Description

A multi-layer output for processing algorithms which create map layers, when the number and nature of the output layers is not predefined.

Note
Always prefer to explicitly define QgsProcessingOutputVectorLayer, QgsProcessingOutputRasterLayer or QgsProcessingOutputMapLayer where possible. QgsProcessingOutputMultipleLayers should only ever be used when the number of output layers is not fixed - e.g. as a result of processing all layers in a specified folder.
Since
QGIS 3.0

Definition at line 268 of file qgsprocessingoutputs.h.

Constructor & Destructor Documentation

◆ QgsProcessingOutputMultipleLayers()

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

Constructor for QgsProcessingOutputMultipleLayers.

Definition at line 81 of file qgsprocessingoutputs.cpp.

Member Function Documentation

◆ type()

QString QgsProcessingOutputMultipleLayers::type ( ) const
overridevirtual

Unique output type name.

Implements QgsProcessingOutputDefinition.

Definition at line 85 of file qgsprocessingoutputs.cpp.

◆ typeName()

static QString QgsProcessingOutputMultipleLayers::typeName ( )
inlinestatic

Returns the type name for the output class.

Definition at line 280 of file qgsprocessingoutputs.h.


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