Class: QgsProcessingOutputDefinition

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.

Class Hierarchy

Subclasses

QgsProcessingOutputBoolean	A boolean output for processing algorithms.
QgsProcessingOutputConditionalBranch	A conditional branch output for processing algorithms, which represents a possible model logic flow which branches out from this algorithm.
QgsProcessingOutputFile	A file output for processing algorithms.
QgsProcessingOutputFolder	A folder output for processing algorithms.
QgsProcessingOutputHtml	A HTML file output for processing algorithms.
QgsProcessingOutputMapLayer	A map layer output for processing algorithms, where layers may be either vector or raster.
QgsProcessingOutputMultipleLayers	A multi-layer output for processing algorithms which create map layers, when the number and nature of the output layers is not predefined.
QgsProcessingOutputNumber	A numeric output for processing algorithms.
QgsProcessingOutputPointCloudLayer	A pointcloud layer output for processing algorithms.
QgsProcessingOutputRasterLayer	A raster layer output for processing algorithms.
QgsProcessingOutputString	A string output for processing algorithms.
QgsProcessingOutputVariant	A variant output for processing algorithms, capable of storing any QVariant value.
QgsProcessingOutputVectorLayer	A vector layer output for processing algorithms.
QgsProcessingOutputVectorTileLayer	A vector tile layer output for processing algorithms.

Methods

autoCreated	Returns True if the output was automatically created when adding a parameter.
description	Returns the description for the output.
name	Returns the name of the output.
setAutoCreated	Sets whether an output was automatically created when adding a parameter.
setDescription	Sets the description for the output.
setName	Sets the name of the output.
type	Unique output type name.
valueAsFormattedString	Returns a HTML string version of the parameter output value (if possible).
valueAsString	Returns a string version of the parameter output value (if possible).

class qgis.core.QgsProcessingOutputDefinition

Bases: object

__init__(name: str | None, description: str | None = '')

Constructor for QgsProcessingOutputDefinition.

Parameters:

• name (Optional[str])

• description (Optional[str] = '')

__init__(a0: QgsProcessingOutputDefinition)

Parameters:

a0 (QgsProcessingOutputDefinition)

autoCreated(self) → bool

Returns True if the output was automatically created when adding a parameter.

See also

setAutoCreated()

Added in version 3.14.

Return type:

bool

description(self) → str

Returns the description for the output. This is the user-visible string used to identify this output.

See also

setDescription()

Return type:

str

name(self) → str

Returns the name of the output. This is the internal identifier by which algorithms access this output.

See also

setName()

Return type:

str

setAutoCreated(self, autoCreated: bool)

Sets whether an output was automatically created when adding a parameter.

Parameters:

autoCreated (bool) – set to True if the output is to be considered as automatically created.

See also

autoCreated()

Added in version 3.14.

setDescription(self, description: str | None)

Sets the description for the output. This is the user-visible string used to identify this output.

See also

description()

Parameters:

description (Optional[str])

setName(self, name: str | None)

Sets the name of the output. This is the internal identifier by which algorithms access this output.

See also

name()

Parameters:

name (Optional[str])

type(self) → str

Unique output type name.

Return type:

str

valueAsFormattedString(self, value: Any, context: QgsProcessingContext)

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

By default this will return the same value as valueAsString().

Parameters:

• value (Any) – value to convert

• context (QgsProcessingContext) -> (str) – processing context

Returns:

• value converted to string

• ok: True if value could be represented as a string.

See also

valueAsString()

Added in version 3.36.

valueAsString(self, value: Any, context: QgsProcessingContext)

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

Parameters:

• value (Any) – value to convert

• context (QgsProcessingContext) -> (str) – processing context

Returns:

• value converted to string

• ok: True if value could be represented as a string.

See also

valueAsFormattedString()

Added in version 3.36.