QgsProcessingFeedback class

Base class for providing feedback from a processing algorithm.

Reference

This base class implementation silently ignores all feedback reported by algorithms. Subclasses of QgsProcessingFeedback can be used to log this feedback or report it to users via the GUI.

Base classes

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

Derived classes

class QgsProcessingMultiStepFeedback: Processing feedback object for multi-step operations.

Public functions

void pushCommandInfo(const QString& info) virtual: Pushes an informational message containing a command from the algorithm.
void pushConsoleInfo(const QString& info) virtual: Pushes a console feedback message from the algorithm.
void pushDebugInfo(const QString& info) virtual: Pushes an informational message containing debugging helpers from the algorithm.
void pushInfo(const QString& info) virtual: Pushes a general informational message from the algorithm.
void reportError(const QString& error, bool fatalError = false) virtual: Reports that the algorithm encountered an error while executing.
void setProgressText(const QString& text) virtual: Sets a progress report text string.

Function documentation

void QgsProcessingFeedback::pushCommandInfo(const QString& info) virtual

Pushes an informational message containing a command from the algorithm.

This is usually used to report commands which are executed in an external application or as subprocesses.

void QgsProcessingFeedback::pushConsoleInfo(const QString& info) virtual

Pushes a console feedback message from the algorithm.

This is used to report the output from executing an external command or subprocess.

void QgsProcessingFeedback::pushDebugInfo(const QString& info) virtual

Pushes an informational message containing debugging helpers from the algorithm.

void QgsProcessingFeedback::pushInfo(const QString& info) virtual

Pushes a general informational message from the algorithm.

This can be used to report feedback which is neither a status report or an error, such as "Found 47 matching features".

void QgsProcessingFeedback::reportError(const QString& error, bool fatalError = false) virtual

Reports that the algorithm encountered an error while executing.

If fatalError is true then the error prevented the algorithm from executing.

void QgsProcessingFeedback::setProgressText(const QString& text) virtual

Sets a progress report text string.

This can be used in conjunction with setProgress() to provide detailed progress reports, such as "Transformed 4 of 5 layers".