Class: QgsModelChildAlgorithmGraphicItem¶
A graphic item representing a child algorithm in the model designer.
Warning
Not stable API
Added in version 3.14.
List of all members, including inherited members
Class Hierarchy¶
Base classes¶
Base class for graphic items representing model components in the model designer. |
|
Constructor
Methods
Returns the index for the input with the specified parameter name, or -1 if the parameter could not be matched. |
|
Returns the index for the output with the specified name, or -1 if the output could not be matched. |
|
Returns the results for this child algorithm for the last model execution through the dialog. |
|
Flags the algorithm as possibly being outdated (i.e. previous results are invalid due to changes elsewhere in the model). |
|
Sets the child's progress. |
|
Sets the results obtained for this child algorithm for the last model execution through the dialog. |
|
Sets the feature count for the sink attached to the specified output. |
|
Sets the feature count for the source attached to the specified input. |
|
Flags the algorithm as having started. |
Signals
Requests that any associated configuration dock widget is rebuilt to reflect the current state of the child algorithm. |
|
Emitted when the user opts to run the model from this child algorithm. |
|
Emitted when the user opts to run selected steps from the model. |
|
Emitted when the user opts to view the previous log from this child algorithm. |
|
Emitted when the user opts to view previous results from this child algorithm. |
- class qgis.gui.QgsModelChildAlgorithmGraphicItem[source]¶
Bases:
QgsModelComponentGraphicItem- __init__(child: QgsProcessingModelChildAlgorithm | None, model: QgsProcessingModelAlgorithm | None, parent: QGraphicsItem | None)¶
Constructor for QgsModelChildAlgorithmGraphicItem for the specified
child, with the specifiedparentitem.The
modelargument specifies the associated processing model. Ownership ofmodelis not transferred, and it must exist for the lifetime of this object.Ownership of
childis transferred to the item.- Parameters:
child (Optional[QgsProcessingModelChildAlgorithm])
model (Optional[QgsProcessingModelAlgorithm])
parent (Optional[QGraphicsItem])
- indexForInput(self, parameterName: str | None) int[source]¶
Returns the index for the input with the specified parameter name, or -1 if the parameter could not be matched.
See also
Added in version 4.2.
- Parameters:
parameterName (Optional[str])
- Return type:
int
- indexForOutput(self, output: str | None) int[source]¶
Returns the index for the output with the specified name, or -1 if the output could not be matched.
See also
Added in version 4.2.
- Parameters:
output (Optional[str])
- Return type:
int
- signal rebuildConfigurationDockWidget[source]¶
Requests that any associated configuration dock widget is rebuilt to reflect the current state of the child algorithm.
Added in version 4.2.
- results(self) QgsProcessingModelChildAlgorithmResult[source]¶
Returns the
resultsfor this child algorithm for the last model execution through the dialog.Added in version 4.0.
- Return type:
- signal runFromHere[source]¶
Emitted when the user opts to run the model from this child algorithm.
Added in version 3.38.
- signal runSelected[source]¶
Emitted when the user opts to run selected steps from the model.
Added in version 3.38.
- setOutdated(self)[source]¶
Flags the algorithm as possibly being outdated (i.e. previous results are invalid due to changes elsewhere in the model).
Added in version 4.2.
- setResults(self, results: QgsProcessingModelChildAlgorithmResult)[source]¶
Sets the
resultsobtained for this child algorithm for the last model execution through the dialog.- Parameters:
results (QgsProcessingModelChildAlgorithmResult)
- setSinkFeatureCount(self, outputName: str | None, featureCount: int)[source]¶
Sets the feature count for the sink attached to the specified output.
This can be used to dynamically update the feature count badge for the matching arrow item.
Added in version 4.2.
- Parameters:
outputName (Optional[str])
featureCount (int)
- setSourceFeatureCount(self, parameterName: str | None, featureCount: int)[source]¶
Sets the feature count for the source attached to the specified input.
This can be used to dynamically update the feature count badge for the matching arrow item.
Added in version 4.2.
- Parameters:
parameterName (Optional[str])
featureCount (int)