QGIS API Documentation  3.11.0-Master (68611307d7)
Public Member Functions | Static Public Member Functions | List of all members
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:
Inheritance graph
[legend]

Public Member Functions

 QgsProcessingOutputMapLayer (const QString &name, const QString &description=QString())
 Constructor for QgsProcessingOutputMapLayer. 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
 
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...
 

Static Public Member Functions

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

Additional Inherited Members

- Protected Attributes inherited from QgsProcessingOutputDefinition
QString mDescription
 Output description. More...
 
QString mName
 Output name. More...
 

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.

Since
QGIS 3.0

Definition at line 136 of file qgsprocessingoutputs.h.

Constructor & Destructor Documentation

◆ QgsProcessingOutputMapLayer()

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

Constructor for QgsProcessingOutputMapLayer.

Definition at line 70 of file qgsprocessingoutputs.cpp.

Member Function Documentation

◆ type()

QString QgsProcessingOutputMapLayer::type ( ) const
overridevirtual

Unique output type name.

Implements QgsProcessingOutputDefinition.

Definition at line 74 of file qgsprocessingoutputs.cpp.

◆ typeName()

static QString QgsProcessingOutputMapLayer::typeName ( )
inlinestatic

Returns the type name for the output class.

Definition at line 148 of file qgsprocessingoutputs.h.


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