Class: QgsProcessingOutputDefinition¶
-
class
qgis.core.
QgsProcessingOutputDefinition
(name: str, description: str = '')¶ Bases:
sip.wrapper
Constructor for QgsProcessingOutputDefinition.
QgsProcessingOutputDefinition(
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.
New in version 3.0.
- Parameters
name (str) –
description –
-
description
(self) → str¶ Returns the description for the output. This is the user-visible string used to identify this output.
See also
- 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
- Return type
str
-
setDescription
(self, description: str)¶ Sets the
description
for the output. This is the user-visible string used to identify this output.See also
- Parameters
description (str) –
-
setName
(self, name: str)¶ Sets the
name
of the output. This is the internal identifier by which algorithms access this output.See also
- Parameters
name (str) –
-
type
(self) → str¶ Unique output type name.
- Return type
str