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:
Methods
Returns
True
if the output was automatically created when adding a parameter.Returns the description for the output.
Returns the name of the output.
Sets whether an output was automatically created when adding a parameter.
Sets the
description
for the output.Sets the
name
of the output.Unique output type name.
- autoCreated(self) bool ¶
Returns
True
if the output was automatically created when adding a parameter.See also
New 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
- 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
- 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
New in version 3.14.
- 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