QGIS API Documentation 3.29.0-Master (8c80f25a4f)
Public Member Functions | List of all members
QgsProcessingBatchFeedback Class Reference

Processing feedback subclass for use when batch processing. More...

#include <qgsprocessingbatch.h>

Inheritance diagram for QgsProcessingBatchFeedback:
Inheritance graph
[legend]

Public Member Functions

 QgsProcessingBatchFeedback (int tasks, QgsProcessingFeedback *feedback)
 Constructor for QgsProcessingBatchFeedback, for a process with the specified number of tasks. More...
 
QStringList popErrors ()
 Takes the current list of reported errors and clears the stored list of errors. More...
 
void reportError (const QString &error, bool fatalError=false) override
 Reports that the algorithm encountered an error while executing. More...
 
- Public Member Functions inherited from QgsProcessingMultiStepFeedback
 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 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 20 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 32 of file qgsprocessingbatch.cpp.

◆ reportError()

void QgsProcessingBatchFeedback::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 26 of file qgsprocessingbatch.cpp.


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