QGIS API Documentation 3.27.0-Master (75dc696944)
Public Member Functions | List of all members
QgsProcessingMultiStepFeedback Class Reference

Processing feedback object for multi-step operations. More...

#include <qgsprocessingfeedback.h>

Inheritance diagram for QgsProcessingMultiStepFeedback:
Inheritance graph
[legend]

Public Member Functions

 QgsProcessingMultiStepFeedback (int steps, QgsProcessingFeedback *feedback)
 Constructor for QgsProcessingMultiStepFeedback, for a process with the specified number of steps. More...
 
QString htmlLog () const override
 Returns the HTML formatted contents of the log, which contains all messages pushed to the feedback object. More...
 
void pushCommandInfo (const QString &info) override
 Pushes an informational message containing a command from the algorithm. More...
 
void pushConsoleInfo (const QString &info) override
 Pushes a console feedback message from the algorithm. More...
 
void pushDebugInfo (const QString &info) override
 Pushes an informational message containing debugging helpers from the algorithm. More...
 
void pushInfo (const QString &info) override
 Pushes a general informational message from the algorithm. More...
 
void pushWarning (const QString &warning) override
 Pushes a warning informational message from the algorithm. More...
 
void reportError (const QString &error, bool fatalError=false) override
 Reports that the algorithm encountered an error while executing. More...
 
void setCurrentStep (int step)
 Sets the step which is being executed. More...
 
void setProgressText (const QString &text) override
 Sets a progress report text string. More...
 
QString textLog () const override
 Returns the plain text contents of the log, which contains all messages pushed to the feedback object. More...
 
- Public Member Functions inherited from QgsProcessingFeedback
 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 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 SIP_HOLDGIL
 Tells whether the operation has been canceled already. More...
 
unsigned long long processedCount () const SIP_HOLDGIL
 Returns the current processed objects count reported by the feedback object. More...
 
double progress () const SIP_HOLDGIL
 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

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.

Since
QGIS 3.0

Definition at line 166 of file qgsprocessingfeedback.h.

Constructor & Destructor Documentation

◆ QgsProcessingMultiStepFeedback()

QgsProcessingMultiStepFeedback::QgsProcessingMultiStepFeedback ( int  steps,
QgsProcessingFeedback feedback 
)

Constructor for QgsProcessingMultiStepFeedback, for a process with the specified number of steps.

This feedback object will proxy calls to the specified feedback object.

Definition at line 153 of file qgsprocessingfeedback.cpp.

Member Function Documentation

◆ htmlLog()

QString QgsProcessingMultiStepFeedback::htmlLog ( ) const
overridevirtual

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 from QgsProcessingFeedback.

Definition at line 202 of file qgsprocessingfeedback.cpp.

◆ pushCommandInfo()

void QgsProcessingMultiStepFeedback::pushCommandInfo ( const QString &  info)
overridevirtual

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 from QgsProcessingFeedback.

Definition at line 187 of file qgsprocessingfeedback.cpp.

◆ pushConsoleInfo()

void QgsProcessingMultiStepFeedback::pushConsoleInfo ( const QString &  info)
overridevirtual

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 from QgsProcessingFeedback.

Definition at line 197 of file qgsprocessingfeedback.cpp.

◆ pushDebugInfo()

void QgsProcessingMultiStepFeedback::pushDebugInfo ( const QString &  info)
overridevirtual

Pushes an informational message containing debugging helpers from the algorithm.

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

Reimplemented from QgsProcessingFeedback.

Definition at line 192 of file qgsprocessingfeedback.cpp.

◆ pushInfo()

void QgsProcessingMultiStepFeedback::pushInfo ( const QString &  info)
overridevirtual

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
pushWarning()
pushCommandInfo()
pushDebugInfo()
pushConsoleInfo()

Reimplemented from QgsProcessingFeedback.

Definition at line 182 of file qgsprocessingfeedback.cpp.

◆ pushWarning()

void QgsProcessingMultiStepFeedback::pushWarning ( const QString &  warning)
overridevirtual

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 from QgsProcessingFeedback.

Definition at line 177 of file qgsprocessingfeedback.cpp.

◆ reportError()

void QgsProcessingMultiStepFeedback::reportError ( const QString &  error,
bool  fatalError = false 
)
overridevirtual

Reports that the algorithm encountered an error while executing.

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

Reimplemented from QgsProcessingFeedback.

Definition at line 172 of file qgsprocessingfeedback.cpp.

◆ setCurrentStep()

void QgsProcessingMultiStepFeedback::setCurrentStep ( int  step)

Sets the step which is being executed.

This is used to scale the current progress to account for progress through the overall process.

Definition at line 161 of file qgsprocessingfeedback.cpp.

◆ setProgressText()

void QgsProcessingMultiStepFeedback::setProgressText ( const QString &  text)
overridevirtual

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 from QgsProcessingFeedback.

Definition at line 167 of file qgsprocessingfeedback.cpp.

◆ textLog()

QString QgsProcessingMultiStepFeedback::textLog ( ) const
overridevirtual

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 from QgsProcessingFeedback.

Definition at line 207 of file qgsprocessingfeedback.cpp.


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