QGIS API Documentation  3.37.0-Master (a5b4d9743e8)
Public Member Functions | List of all members
QgsProcessingFeedback Class Reference

Base class for providing feedback from a processing algorithm. More...

#include <qgsprocessingfeedback.h>

Inheritance diagram for QgsProcessingFeedback:
Inheritance graph
[legend]

Public Member Functions

 QgsProcessingFeedback (bool logFeedback=true)
 Constructor for QgsProcessingFeedback. More...
 
virtual QString htmlLog () const
 Returns the HTML formatted contents of the log, which contains all messages pushed to the feedback object. More...
 
virtual void pushCommandInfo (const QString &info)
 Pushes an informational message containing a command from the algorithm. More...
 
virtual void pushConsoleInfo (const QString &info)
 Pushes a console feedback message from the algorithm. More...
 
virtual void pushDebugInfo (const QString &info)
 Pushes an informational message containing debugging helpers from the algorithm. More...
 
virtual void pushFormattedMessage (const QString &html, const QString &text)
 Pushes a pre-formatted message from the algorithm. More...
 
void pushFormattedResults (const QgsProcessingAlgorithm *algorithm, QgsProcessingContext &context, const QVariantMap &results)
 Pushes a summary of the execution results to the log. More...
 
virtual void pushInfo (const QString &info)
 Pushes a general informational message from the algorithm. More...
 
void pushVersionInfo (const QgsProcessingProvider *provider=nullptr)
 Pushes a summary of the QGIS (and underlying library) version information to the log. More...
 
virtual void pushWarning (const QString &warning)
 Pushes a warning informational message from the algorithm. More...
 
virtual void reportError (const QString &error, bool fatalError=false)
 Reports that the algorithm encountered an error while executing. More...
 
virtual void setProgressText (const QString &text)
 Sets a progress report text string. More...
 
virtual QString textLog () const
 Returns the plain text contents of the log, which contains all messages pushed to the feedback object. More...
 
- Public Member Functions inherited from QgsFeedback
 QgsFeedback (QObject *parent=nullptr)
 Construct a feedback object. More...
 
bool isCanceled () const
 Tells whether the operation has been canceled already. More...
 
unsigned long long processedCount () const
 Returns the current processed objects count reported by the feedback object. More...
 
double progress () const
 Returns the current progress reported by the feedback object. More...
 
void setProcessedCount (unsigned long long processedCount)
 Sets the current processed objects count for the feedback object. More...
 
void setProgress (double progress)
 Sets the current progress for the feedback object. More...
 

Additional Inherited Members

- Public Slots inherited from QgsFeedback
void cancel ()
 Tells the internal routines that the current operation should be canceled. This should be run by the main thread. More...
 
- Signals inherited from QgsFeedback
void canceled ()
 Internal routines can connect to this signal if they use event loop. More...
 
void processedCountChanged (unsigned long long processedCount)
 Emitted when the feedback object reports a change in the number of processed objects. More...
 
void progressChanged (double progress)
 Emitted when the feedback object reports a progress change. More...
 

Detailed Description

Base class for providing feedback from a processing algorithm.

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.

Definition at line 37 of file qgsprocessingfeedback.h.

Constructor & Destructor Documentation

◆ QgsProcessingFeedback()

QgsProcessingFeedback::QgsProcessingFeedback ( bool  logFeedback = true)

Constructor for QgsProcessingFeedback.

If logFeedback is true, then all feedback received will be directed to QgsMessageLog.

Definition at line 30 of file qgsprocessingfeedback.cpp.

Member Function Documentation

◆ htmlLog()

QString QgsProcessingFeedback::htmlLog ( ) const
virtual

Returns the HTML formatted contents of the log, which contains all messages pushed to the feedback object.

See also
textLog()
Since
QGIS 3.14

Reimplemented in QgsProcessingMultiStepFeedback.

Definition at line 180 of file qgsprocessingfeedback.cpp.

◆ pushCommandInfo()

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.

See also
pushWarning()
pushInfo()
pushDebugInfo()
pushConsoleInfo()

Reimplemented in QgsProcessingMultiStepFeedback.

Definition at line 96 of file qgsprocessingfeedback.cpp.

◆ pushConsoleInfo()

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.

See also
pushWarning()
pushInfo()
pushDebugInfo()
pushCommandInfo()

Reimplemented in QgsProcessingMultiStepFeedback.

Definition at line 114 of file qgsprocessingfeedback.cpp.

◆ pushDebugInfo()

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

Pushes an informational message containing debugging helpers from the algorithm.

See also
pushWarning()
pushInfo()
pushCommandInfo()
pushConsoleInfo()

Reimplemented in QgsProcessingMultiStepFeedback.

Definition at line 105 of file qgsprocessingfeedback.cpp.

◆ pushFormattedMessage()

void QgsProcessingFeedback::pushFormattedMessage ( const QString &  html,
const QString &  text 
)
virtual

Pushes a pre-formatted message from the algorithm.

This can be used to push formatted HTML messages to the feedback object. A plain text version of the message must also be specified.

See also
pushInfo()
pushWarning()
pushCommandInfo()
pushDebugInfo()
pushConsoleInfo()
Since
QGIS 3.36

Reimplemented in QgsProcessingMultiStepFeedback.

Definition at line 87 of file qgsprocessingfeedback.cpp.

◆ pushFormattedResults()

void QgsProcessingFeedback::pushFormattedResults ( const QgsProcessingAlgorithm algorithm,
QgsProcessingContext context,
const QVariantMap &  results 
)

Pushes a summary of the execution results to the log.

Since
QGIS 3.36

Definition at line 152 of file qgsprocessingfeedback.cpp.

◆ pushInfo()

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".

See also
pushFormattedMessage()
pushWarning()
pushCommandInfo()
pushDebugInfo()
pushConsoleInfo()

Reimplemented in QgsProcessingMultiStepFeedback.

Definition at line 78 of file qgsprocessingfeedback.cpp.

◆ pushVersionInfo()

void QgsProcessingFeedback::pushVersionInfo ( const QgsProcessingProvider provider = nullptr)

Pushes a summary of the QGIS (and underlying library) version information to the log.

Since
QGIS 3.4.7

Definition at line 123 of file qgsprocessingfeedback.cpp.

◆ pushWarning()

void QgsProcessingFeedback::pushWarning ( const QString &  warning)
virtual

Pushes a warning informational message from the algorithm.

This should only be used sparsely as to maintain the importance of visual queues associated to this type of message.

See also
pushInfo()
pushCommandInfo()
pushDebugInfo()
pushConsoleInfo()
Since
QGIS 3.16.2

Reimplemented in QgsProcessingMultiStepFeedback.

Definition at line 69 of file qgsprocessingfeedback.cpp.

◆ reportError()

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.

Reimplemented in QgsProcessingMultiStepFeedback, and QgsProcessingBatchFeedback.

Definition at line 60 of file qgsprocessingfeedback.cpp.

◆ setProgressText()

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".

See also
setProgress()

Reimplemented in QgsProcessingMultiStepFeedback.

Definition at line 36 of file qgsprocessingfeedback.cpp.

◆ textLog()

QString QgsProcessingFeedback::textLog ( ) const
virtual

Returns the plain text contents of the log, which contains all messages pushed to the feedback object.

See also
htmlLog()
Since
QGIS 3.14

Reimplemented in QgsProcessingMultiStepFeedback.

Definition at line 185 of file qgsprocessingfeedback.cpp.


The documentation for this class was generated from the following files: