QGIS API Documentation
3.0.2-Girona (307d082)
|
Base class for the definition of processing outputs. More...
#include <qgsprocessingoutputs.h>
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... | |
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.
Definition at line 41 of file qgsprocessingoutputs.h.
QgsProcessingOutputDefinition::QgsProcessingOutputDefinition | ( | const QString & | name, |
const QString & | description = QString() |
||
) |
Constructor for QgsProcessingOutputDefinition.
Definition at line 20 of file qgsprocessingoutputs.cpp.
|
virtualdefault |
|
inline |
Returns the description for the output.
This is the user-visible string used to identify this output.
Definition at line 102 of file qgsprocessingoutputs.h.
|
inline |
Returns the name of the output.
This is the internal identifier by which algorithms access this output.
Definition at line 88 of file qgsprocessingoutputs.h.
|
inline |
Sets the description for the output.
This is the user-visible string used to identify this output.
Definition at line 109 of file qgsprocessingoutputs.h.
|
inline |
Sets the name of the output.
This is the internal identifier by which algorithms access this output.
Definition at line 95 of file qgsprocessingoutputs.h.
|
pure virtual |
Unique output type name.
Implemented in QgsProcessingOutputFile, QgsProcessingOutputFolder, QgsProcessingOutputString, QgsProcessingOutputNumber, QgsProcessingOutputHtml, QgsProcessingOutputMultipleLayers, QgsProcessingOutputRasterLayer, QgsProcessingOutputVectorLayer, and QgsProcessingOutputMapLayer.
|
protected |
Output description.
Definition at line 117 of file qgsprocessingoutputs.h.
|
protected |
Output name.
Definition at line 114 of file qgsprocessingoutputs.h.