Class: QgsProcessingModelOutput¶
-
class
qgis.core.
QgsProcessingModelOutput
(name: str = '', description: str = '')¶ Bases:
qgis._core.QgsProcessingModelComponent
Constructor for QgsProcessingModelOutput with the specified
name
anddescription
.QgsProcessingModelOutput(QgsProcessingModelOutput)
Represents a final output created by the model.
New in version 3.0: Enums
Methods
Returns the child algorithm ID from which this output is generated.
Returns the child algorithm output name from which this output is generated.
Returns the default value for the model output parameter.
Returns true if the output is mandatory.
Loads this output from a QVariantMap.
Returns the model output name.
Sets the child algorithm
id
from which this output is generated.Sets the child algorithm output
name
from which this output is generated.Sets the default value for the model output.
Sets whether the output is
mandatory
.Sets the model output
name
.Saves this output to a QVariant.
Signals
Attributes
-
childId
(self) → str¶ Returns the child algorithm ID from which this output is generated.
See also
-
childOutputName
(self) → str¶ Returns the child algorithm output name from which this output is generated.
See also
setOutputName()
-
defaultValue
(self) → Any¶ Returns the default value for the model output parameter.
See also
New in version 3.2.
-
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.
-
loadVariant
(self, map: Dict[str, Any]) → bool¶ Loads this output from a QVariantMap.
See also
-
restoreCommonProperties
()¶
-
saveCommonProperties
()¶
-
setChildId
(self, id: str)¶ Sets the child algorithm
id
from which this output is generated.See also
-
setChildOutputName
(self, name: str)¶ Sets the child algorithm output
name
from which this output is generated.See also
outputName()
-
setDefaultValue
(self, value: Any)¶ Sets the default value for the model output.
See also
New in version 3.2.
-
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.
-
toVariant
(self) → Any¶ Saves this output to a QVariant.
See also
-