Class: QgsProcessingMultiStepFeedback

Processing feedback object for multi-step operations.

A processing feedback object which proxies its calls to an underlying feedback object, but scales overall progress reports to account for a number of child steps which each report their own feedback.

Class Hierarchy

Inheritance diagram of qgis.core.QgsProcessingMultiStepFeedback

Base classes

QgsProcessingFeedback

Base class for providing feedback from a processing algorithm.

QgsFeedback

Base class for feedback objects to be used for cancellation of something running in a worker thread.

QObject

Subclasses

QgsProcessingBatchFeedback

Processing feedback subclass for use when batch processing.

Methods

setCurrentStep

Sets the step which is being executed.

class qgis.core.QgsProcessingMultiStepFeedback[source]

Bases: QgsProcessingFeedback

__init__(steps: int, feedback: QgsProcessingFeedback | None)

Constructor for QgsProcessingMultiStepFeedback, for a process with the specified number of steps. This feedback object will proxy calls to the specified feedback object.

Parameters:
setCurrentStep(self, step: int)[source]

Sets the step which is being executed. This is used to scale the current progress to account for progress through the overall process.

Parameters:

step (int)