Processing feedback subclass for use when batch processing. More...
#include <qgsprocessingbatch.h>
Inheritance diagram for QgsProcessingBatchFeedback:
Public Member Functions | |
| QgsProcessingBatchFeedback (int tasks, QgsProcessingFeedback *feedback) | |
| Constructor for QgsProcessingBatchFeedback, for a process with the specified number of tasks. | |
| QStringList | popErrors () |
| Takes the current list of reported errors and clears the stored list of errors. | |
| void | reportError (const QString &error, bool fatalError=false) override |
| Reports that the algorithm encountered an error while executing. | |
 Public Member Functions inherited from QgsProcessingMultiStepFeedback | |
| QgsProcessingMultiStepFeedback (int steps, QgsProcessingFeedback *feedback) | |
| Constructor for QgsProcessingMultiStepFeedback, for a process with the specified number of steps. | |
| QString | htmlLog () const override |
| Returns the HTML formatted contents of the log, which contains all messages pushed to the feedback object. | |
| void | pushCommandInfo (const QString &info) override |
| Pushes an informational message containing a command from the algorithm. | |
| void | pushConsoleInfo (const QString &info) override |
| Pushes a console feedback message from the algorithm. | |
| void | pushDebugInfo (const QString &info) override |
| Pushes an informational message containing debugging helpers from the algorithm. | |
| void | pushFormattedMessage (const QString &html, const QString &text) override |
| Pushes a pre-formatted message from the algorithm. | |
| void | pushInfo (const QString &info) override |
| Pushes a general informational message from the algorithm. | |
| void | pushWarning (const QString &warning) override |
| Pushes a warning informational message from the algorithm. | |
| void | reportError (const QString &error, bool fatalError=false) override |
| Reports that the algorithm encountered an error while executing. | |
| void | setCurrentStep (int step) |
| Sets the step which is being executed. | |
| void | setProgressText (const QString &text) override |
| Sets a progress report text string. | |
| QString | textLog () const override |
| Returns the plain text contents of the log, which contains all messages pushed to the feedback object. | |
| Public Member Functions inherited from QgsProcessingFeedback | |
| QgsProcessingFeedback (bool logFeedback=true) | |
| Constructor for QgsProcessingFeedback. | |
| void | pushFormattedResults (const QgsProcessingAlgorithm *algorithm, QgsProcessingContext &context, const QVariantMap &results) |
| Pushes a summary of the execution results to the log. | |
| void | pushVersionInfo (const QgsProcessingProvider *provider=nullptr) |
| Pushes a summary of the QGIS (and underlying library) version information to the log. | |
| Public Member Functions inherited from QgsFeedback | |
| QgsFeedback (QObject *parent=nullptr) | |
| Construct a feedback object. | |
| bool | isCanceled () const |
| Tells whether the operation has been canceled already. | |
| unsigned long long | processedCount () const |
| Returns the current processed objects count reported by the feedback object. | |
| double | progress () const |
| Returns the current progress reported by the feedback object. | |
| void | setProcessedCount (unsigned long long processedCount) |
| Sets the current processed objects count for the feedback object. | |
| void | setProgress (double progress) |
| Sets the current progress for the feedback object. | |
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. | |
| Signals inherited from QgsFeedback | |
| void | canceled () |
| Internal routines can connect to this signal if they use event loop. | |
| void | processedCountChanged (unsigned long long processedCount) |
| Emitted when the feedback object reports a change in the number of processed objects. | |
| void | progressChanged (double progress) |
| Emitted when the feedback object reports a progress change. | |
Detailed Description
Processing feedback subclass for use when batch processing.
- Since
- QGIS 3.26
Definition at line 32 of file qgsprocessingbatch.h.
Constructor & Destructor Documentation
◆ QgsProcessingBatchFeedback()
| QgsProcessingBatchFeedback::QgsProcessingBatchFeedback | ( | int | tasks, |
| QgsProcessingFeedback * | feedback | ||
| ) |
Constructor for QgsProcessingBatchFeedback, for a process with the specified number of tasks.
This feedback object will proxy calls to the specified feedback object.
Definition at line 21 of file qgsprocessingbatch.cpp.
Member Function Documentation
◆ popErrors()
| QStringList QgsProcessingBatchFeedback::popErrors | ( | ) |
Takes the current list of reported errors and clears the stored list of errors.
Definition at line 33 of file qgsprocessingbatch.cpp.
◆ reportError()
|
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 27 of file qgsprocessingbatch.cpp.
The documentation for this class was generated from the following files:
- /build/qgis-3.41.0+git20241110+fda2aa46e9a+99sid/src/core/processing/qgsprocessingbatch.h
- /build/qgis-3.41.0+git20241110+fda2aa46e9a+99sid/src/core/processing/qgsprocessingbatch.cpp
