Class: QgsProcessingMultiStepFeedback

class qgis.core.QgsProcessingMultiStepFeedback

Bases: QgsProcessingFeedback

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.

New in version 3.0.

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

Methods

childEvent

connectNotify

customEvent

disconnectNotify

htmlLog

rtype

str

isSignalConnected

pushCommandInfo

param info

pushConsoleInfo

param info

pushDebugInfo

param info

pushInfo

param info

pushWarning

param warning

receivers

reportError

param error

sender

senderSignalIndex

setCurrentStep

Sets the step which is being executed.

setProgressText

param text

textLog

rtype

str

timerEvent

childEvent(self, QChildEvent)
connectNotify(self, QMetaMethod)
customEvent(self, QEvent)
disconnectNotify(self, QMetaMethod)
htmlLog(self)str
Return type

str

isSignalConnected(self, QMetaMethod)bool
pushCommandInfo(self, info: str)
Parameters

info (str) –

pushConsoleInfo(self, info: str)
Parameters

info (str) –

pushDebugInfo(self, info: str)
Parameters

info (str) –

pushInfo(self, info: str)
Parameters

info (str) –

pushWarning(self, warning: str)
Parameters

warning (str) –

receivers(self, PYQT_SIGNAL)int
reportError(self, error: str, fatalError: bool = False)
Parameters
  • error (str) –

  • fatalError (bool = False) –

sender(self)QObject
senderSignalIndex(self)int
setCurrentStep(self, step: int)

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) –

setProgressText(self, text: str)
Parameters

text (str) –

textLog(self)str
Return type

str

timerEvent(self, QTimerEvent)