QGIS API Documentation 3.39.0-Master (bca3cdb6021)
|
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. | |
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 | type () const =0 |
Unique output type name. | |
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). | |
Protected Attributes | |
bool | mAutoCreated = false |
QString | mDescription |
Output description. | |
QString | mName |
Output name. | |
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 24 of file qgsprocessingoutputs.cpp.
|
virtualdefault |
|
inline |
Returns true
if the output was automatically created when adding a parameter.
Definition at line 134 of file qgsprocessingoutputs.h.
|
inline |
Returns the description for the output.
This is the user-visible string used to identify this output.
Definition at line 112 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 98 of file qgsprocessingoutputs.h.
|
inline |
Sets whether an output was automatically created when adding a parameter.
autoCreated | set to true if the output is to be considered as automatically created. |
Definition at line 127 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 119 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 105 of file qgsprocessingoutputs.h.
|
pure virtual |
Unique output type name.
Implemented in QgsProcessingOutputMapLayer, QgsProcessingOutputVectorLayer, QgsProcessingOutputRasterLayer, QgsProcessingOutputPointCloudLayer, QgsProcessingOutputMultipleLayers, QgsProcessingOutputHtml, QgsProcessingOutputVariant, QgsProcessingOutputNumber, QgsProcessingOutputString, QgsProcessingOutputBoolean, QgsProcessingOutputFolder, QgsProcessingOutputFile, QgsProcessingOutputConditionalBranch, and QgsProcessingOutputVectorTileLayer.
|
virtual |
Returns a HTML string version of the parameter output value (if possible).
By default this will return the same value as valueAsString().
value | value to convert |
context | processing context |
ok | will be set to true if value could be represented as a string. |
Reimplemented in QgsProcessingOutputHtml, QgsProcessingOutputFolder, and QgsProcessingOutputFile.
Definition at line 46 of file qgsprocessingoutputs.cpp.
|
virtual |
Returns a string version of the parameter output value (if possible).
value | value to convert |
context | processing context |
ok | will be set to true if value could be represented as a string. |
Reimplemented in QgsProcessingOutputMultipleLayers, QgsProcessingOutputVariant, QgsProcessingOutputNumber, and QgsProcessingOutputBoolean.
Definition at line 29 of file qgsprocessingoutputs.cpp.
|
protected |
Definition at line 174 of file qgsprocessingoutputs.h.
|
protected |
Output description.
Definition at line 172 of file qgsprocessingoutputs.h.
|
protected |
Output name.
Definition at line 169 of file qgsprocessingoutputs.h.