QGIS API Documentation
3.0.2-Girona (307d082)
|
Processing feedback object for multi-step operations. More...
#include <qgsprocessingfeedback.h>
Public Member Functions | |
QgsProcessingMultiStepFeedback (int steps, QgsProcessingFeedback *feedback) | |
Constructor for QgsProcessingMultiStepFeedback, for a process with the specified number of steps. 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 | reportError (const QString &error, bool fatalError) 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... | |
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... | |
double | progress () const |
Returns the current progress reported by 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 | progressChanged (double progress) |
Emitted when the feedback object reports a progress change. More... | |
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.
Definition at line 109 of file qgsprocessingfeedback.h.
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 20 of file qgsprocessingfeedback.cpp.
|
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.
Reimplemented from QgsProcessingFeedback.
Definition at line 49 of file qgsprocessingfeedback.cpp.
|
overridevirtual |
Pushes a console feedback message from the algorithm.
This is used to report the output from executing an external command or subprocess.
Reimplemented from QgsProcessingFeedback.
Definition at line 59 of file qgsprocessingfeedback.cpp.
|
overridevirtual |
Pushes an informational message containing debugging helpers from the algorithm.
Reimplemented from QgsProcessingFeedback.
Definition at line 54 of file qgsprocessingfeedback.cpp.
|
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".
Reimplemented from QgsProcessingFeedback.
Definition at line 44 of file qgsprocessingfeedback.cpp.
|
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 39 of file qgsprocessingfeedback.cpp.
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 28 of file qgsprocessingfeedback.cpp.
|
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".
Reimplemented from QgsProcessingFeedback.
Definition at line 34 of file qgsprocessingfeedback.cpp.