QGIS API Documentation
3.16.0-Hannover (43b64b13f3)
|
Go to the documentation of this file.
22 #include <gdal_version.h>
23 #if PROJ_VERSION_MAJOR > 4
30 : mLogFeedback( logFeedback )
44 mHtmlLog.append( QStringLiteral(
"<span style=\"color:red\">%1</span><br/>" ).arg( error.toHtmlEscaped() ).replace(
'\n', QLatin1String(
"<br>" ) ) );
45 mTextLog.append( error +
'\n' );
53 mHtmlLog.append( info.toHtmlEscaped().replace(
'\n', QLatin1String(
"<br>" ) ) + QStringLiteral(
"<br/>" ) );
54 mTextLog.append( info +
'\n' );
62 mHtmlLog.append( QStringLiteral(
"<code>%1</code><br/>" ).arg( info.toHtmlEscaped().replace(
'\n', QLatin1String(
"<br>" ) ) ) );
63 mTextLog.append( info +
'\n' );
71 mHtmlLog.append( QStringLiteral(
"<span style=\"color:#777\">%1</span><br/>" ).arg( info.toHtmlEscaped().replace(
'\n', QLatin1String(
"<br>" ) ) ) );
72 mTextLog.append( info +
'\n' );
80 mHtmlLog.append( QStringLiteral(
"<code style=\"color:#777\">%1</code><br/>" ).arg( info.toHtmlEscaped().replace(
'\n', QLatin1String(
"<br>" ) ) ) );
81 mTextLog.append( info +
'\n' );
92 pushDebugInfo( tr(
"GDAL version: %1" ).arg( GDALVersionInfo(
"RELEASE_NAME" ) ) );
93 pushDebugInfo( tr(
"GEOS version: %1" ).arg( GEOSversion() ) );
95 #if PROJ_VERSION_MAJOR > 4
96 PJ_INFO info = proj_info();
97 pushDebugInfo( tr(
"PROJ version: %1" ).arg( info.release ) );
101 if ( provider && !provider->
versionInfo().isEmpty() )
119 : mChildSteps( childAlgorithmCount )
120 , mFeedback( feedback )
129 mFeedback->
setProgress( 100.0 *
static_cast< double >( mCurrentStep ) / mChildSteps );
172 void QgsProcessingMultiStepFeedback::updateOverallProgress(
double progress )
174 double baseProgress = 100.0 *
static_cast< double >( mCurrentStep ) / mChildSteps;
175 double currentAlgorithmProgress =
progress / mChildSteps;
176 mFeedback->
setProgress( baseProgress + currentAlgorithmProgress );
void setProgress(double progress)
Sets the current progress for the feedback object.
virtual void setProgressText(const QString &text)
Sets a progress report text string.
QgsProcessingFeedback(bool logFeedback=true)
Constructor for QgsProcessingFeedback.
static QString version()
Version string.
virtual void pushCommandInfo(const QString &info)
Pushes an informational message containing a command from the algorithm.
Base class for providing feedback from a processing algorithm.
void canceled()
Internal routines can connect to this signal if they use event loop.
virtual void pushInfo(const QString &info)
Pushes a general informational message from the algorithm.
virtual void reportError(const QString &error, bool fatalError=false)
Reports that the algorithm encountered an error while executing.
double progress() const
Returns the current progress reported by the feedback object.
Abstract base class for processing providers.
void reportError(const QString &error, bool fatalError=false) override
Reports that the algorithm encountered an error while executing.
virtual QString textLog() const
Returns the plain text contents of the log, which contains all messages pushed to the feedback object...
void cancel()
Tells the internal routines that the current operation should be canceled. This should be run by the ...
virtual QString versionInfo() const
Returns a version information string for the provider, or an empty string if this is not applicable (...
void pushConsoleInfo(const QString &info) override
Pushes a console feedback message from the algorithm.
virtual void pushConsoleInfo(const QString &info)
Pushes a console feedback message from the algorithm.
QString htmlLog() const override
Returns the HTML formatted contents of the log, which contains all messages pushed to the feedback ob...
virtual QString name() const =0
Returns the provider name, which is used to describe the provider within the GUI.
QgsProcessingMultiStepFeedback(int steps, QgsProcessingFeedback *feedback)
Constructor for QgsProcessingMultiStepFeedback, for a process with the specified number of steps.
void pushVersionInfo(const QgsProcessingProvider *provider=nullptr)
Pushes a summary of the QGIS (and underlying library) version information to the log.
void progressChanged(double progress)
Emitted when the feedback object reports a progress change.
void pushDebugInfo(const QString &info) override
Pushes an informational message containing debugging helpers from the algorithm.
virtual void pushDebugInfo(const QString &info)
Pushes an informational message containing debugging helpers from the algorithm.
static void logMessage(const QString &message, const QString &tag=QString(), Qgis::MessageLevel level=Qgis::Warning, bool notifyUser=true)
Adds a message to the log instance (and creates it if necessary).
virtual QString htmlLog() const
Returns the HTML formatted contents of the log, which contains all messages pushed to the feedback ob...
QString textLog() const override
Returns the plain text 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 pushInfo(const QString &info) override
Pushes a general informational message from the algorithm.
void setCurrentStep(int step)
Sets the step which is being executed.
void setProgressText(const QString &text) override
Sets a progress report text string.
static QString devVersion()
The development version.