Class: QgsProcessingModelOutput¶
-
class
qgis.core.
QgsProcessingModelOutput
(name: str = '', description: str = '')¶ Bases:
QgsProcessingModelComponent
Constructor for
QgsProcessingModelOutput
with the specifiedname
anddescription
.QgsProcessingModelOutput(
QgsProcessingModelOutput
)Represents a final output created by the model.
New in version 3.0.
- Parameters
name (str = '') –
description –
-
childId
(self) → str¶ Returns the child algorithm ID from which this output is generated.
See also
- Return type
str
-
childOutputName
(self) → str¶ Returns the child algorithm output name from which this output is generated.
See also
setOutputName()
- Return type
str
-
defaultValue
(self) → Any¶ Returns the default value for the model output parameter.
See also
New in version 3.2.
- Return type
Any
-
isMandatory
(self) → bool¶ Returns
True
if the output is mandatory. This may override the associated child algorithm’s parameter optional status - e.g. allowing an optional output from an algorithm to be mandatory within a model.See also
New in version 3.2.
- Return type
bool
-
loadVariant
(self, map: Dict[str, Any]) → bool¶ Loads this output from a QVariantMap.
See also
- Parameters
map (Dict[str) –
- Return type
bool
-
restoreCommonProperties
(self, map: Dict[str, Any])¶ Restores the component properties from a QVariantMap.
See also
-
saveCommonProperties
(self, map: Dict[str, Any])¶ Saves the component properties to a QVariantMap.
See also
-
setChildId
(self, id: str)¶ Sets the child algorithm
id
from which this output is generated.See also
- Parameters
id (str) –
-
setChildOutputName
(self, name: str)¶ Sets the child algorithm output
name
from which this output is generated.See also
outputName()
- Parameters
name (str) –
-
setDefaultValue
(self, value: Any)¶ Sets the default value for the model output.
See also
New in version 3.2.
- Parameters
value (Any) –
-
setMandatory
(self, mandatory: bool)¶ Sets whether the output is
mandatory
. This may override the associated child algorithm’s parameter optional status - e.g. allowing an optional output from an algorithm to be mandatory within a model.See also
New in version 3.2.
- Parameters
mandatory (bool) –
-
toVariant
(self) → Any¶ Saves this output to a QVariant.
See also
- Return type
Any