QGIS API Documentation 3.37.0-Master (684a802617f)
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
QgsProcessingOutputNumber Class Reference

A numeric output for processing algorithms. More...

#include <qgsprocessingoutputs.h>

Inheritance diagram for QgsProcessingOutputNumber:
Inheritance graph
[legend]

Public Member Functions

 QgsProcessingOutputNumber (const QString &name, const QString &description=QString())
 Constructor for QgsProcessingOutputNumber.
 
QString type () const override
 Unique output type name.
 
QString valueAsString (const QVariant &value, QgsProcessingContext &context, bool &ok) const override
 Returns a string version of the parameter output value (if possible).
 
- 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).
 

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.
 

Detailed Description

A numeric output for processing algorithms.

Definition at line 369 of file qgsprocessingoutputs.h.

Constructor & Destructor Documentation

◆ QgsProcessingOutputNumber()

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

Constructor for QgsProcessingOutputNumber.

Definition at line 93 of file qgsprocessingoutputs.cpp.

Member Function Documentation

◆ type()

QString QgsProcessingOutputNumber::type ( ) const
inlineoverridevirtual

Unique output type name.

Implements QgsProcessingOutputDefinition.

Definition at line 382 of file qgsprocessingoutputs.h.

◆ typeName()

static QString QgsProcessingOutputNumber::typeName ( )
inlinestatic

Returns the type name for the output class.

Definition at line 381 of file qgsprocessingoutputs.h.

◆ valueAsString()

QString QgsProcessingOutputNumber::valueAsString ( const QVariant &  value,
QgsProcessingContext context,
bool &  ok 
) const
overridevirtual

Returns a string version of the parameter output value (if possible).

Parameters
valuevalue to convert
contextprocessing context
okwill be set to true if value could be represented as a string.
Returns
value converted to string
See also
valueAsFormattedString()
Since
QGIS 3.36

Reimplemented from QgsProcessingOutputDefinition.

Definition at line 97 of file qgsprocessingoutputs.cpp.


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