QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
|
A map layer output for processing algorithms, where layers may be either vector or raster. More...
#include <qgsprocessingoutputs.h>
Public Member Functions | |
QgsProcessingOutputMapLayer (const QString &name, const QString &description=QString()) | |
Constructor for QgsProcessingOutputMapLayer. | |
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. | |
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.
Definition at line 189 of file qgsprocessingoutputs.h.
QgsProcessingOutputMapLayer::QgsProcessingOutputMapLayer | ( | const QString & | name, |
const QString & | description = QString() |
||
) |
Constructor for QgsProcessingOutputMapLayer.
Definition at line 164 of file qgsprocessingoutputs.cpp.
|
overridevirtual |
Unique output type name.
Implements QgsProcessingOutputDefinition.
Definition at line 168 of file qgsprocessingoutputs.cpp.
|
inlinestatic |
Returns the type name for the output class.
Definition at line 201 of file qgsprocessingoutputs.h.