Class: QgsProcessingAlgRunnerTask¶
- class qgis.core.QgsProcessingAlgRunnerTask¶
Bases:
QgsTask
QgsTask
task which runs aQgsProcessingAlgorithm
in a background task.New in version 3.0.
QgsProcessingAlgRunnerTask(algorithm:
QgsProcessingAlgorithm
, parameters: Dict[str, Any], context:QgsProcessingContext
, feedback:QgsProcessingFeedback
= None) Constructor forQgsProcessingAlgRunnerTask
. Takes analgorithm
, algorithmparameters
and processingcontext
.Methods
- param result
Will return
True
if task should terminate ASAP.- rtype
bool
Sets the task's current progress.
Signals
Emitted when the algorithm has finished execution.
- cancel(self)¶
- childEvent(self, QChildEvent)¶
- connectNotify(self, QMetaMethod)¶
- customEvent(self, QEvent)¶
- disconnectNotify(self, QMetaMethod)¶
- executed¶
Emitted when the algorithm has finished execution. If the algorithm completed execution without errors then
successful
will beTrue
. Theresults
argument contains the results reported by the algorithm. [signal]- Parameters
successful (bool) –
results (Dict[str) –
- finished(self, result: bool)¶
- Parameters
result (bool) –
- isCanceled(self) bool ¶
Will return
True
if task should terminate ASAP. If the task reports the CanCancel flag, then derived classes’run()
methods should periodically check this and terminate in a safe manner.
- isSignalConnected(self, QMetaMethod) bool ¶
- receivers(self, PYQT_SIGNAL) int ¶
- run(self) bool ¶
- Return type
bool
- sender(self) QObject ¶
- senderSignalIndex(self) int ¶
- setProgress(self, progress: float)¶
Sets the task’s current progress. The derived class should call this method whenever the task wants to update its progress. Calling will automatically emit the progressChanged signal.
- Parameters
progress – percent of progress, from 0.0 - 100.0
- timerEvent(self, QTimerEvent)¶