23#include <gdal_version.h>
27#include <pdal/pdal.hpp>
31 : mLogFeedback( logFeedback )
38 mHtmlLog.append( text.toHtmlEscaped().replace(
'\n', QLatin1String(
"<br>" ) ) + QStringLiteral(
"<br/>" ) );
39 mTextLog.append( text +
'\n' );
42void QgsProcessingFeedback::log(
const QString &htmlMessage,
const QString &textMessage )
44 constexpr int MESSAGE_COUNT_LIMIT = 10000;
46 if ( mMessageLoggedCount == MESSAGE_COUNT_LIMIT )
48 ++mMessageLoggedCount;
49 if ( mMessageLoggedCount == MESSAGE_COUNT_LIMIT )
51 mHtmlLog.append( QStringLiteral(
"<span style=\"color:red\">%1</span><br/>" ).arg( tr(
"Message log truncated" ) ) );
52 mTextLog.append( tr(
"Message log truncated" ) +
'\n' );
56 mHtmlLog.append( htmlMessage );
57 mTextLog.append( textMessage );
67 log( QStringLiteral(
"<span style=\"color:red\">%1</span><br/>" ).arg( error.toHtmlEscaped() ).replace(
'\n', QLatin1String(
"<br>" ) ),
76 log( QStringLiteral(
"<span style=\"color:#b85a20;\">%1</span><br/>" ).arg( warning.toHtmlEscaped() ).replace(
'\n', QLatin1String(
"<br>" ) ) + QStringLiteral(
"<br/>" ),
85 mHtmlLog.append( info.toHtmlEscaped().replace(
'\n', QLatin1String(
"<br>" ) ) + QStringLiteral(
"<br/>" ) );
86 mTextLog.append( info +
'\n' );
94 mHtmlLog.append( html + QStringLiteral(
"<br/>" ) );
95 mTextLog.append( text +
'\n' );
103 log( QStringLiteral(
"<code>%1</code><br/>" ).arg( info.toHtmlEscaped().replace(
'\n', QLatin1String(
"<br>" ) ) ),
112 log( QStringLiteral(
"<span style=\"color:#777\">%1</span><br/>" ).arg( info.toHtmlEscaped().replace(
'\n', QLatin1String(
"<br>" ) ) ),
121 log( QStringLiteral(
"<code style=\"color:#777\">%1</code><br/>" ).arg( info.toHtmlEscaped().replace(
'\n', QLatin1String(
"<br>" ) ) ),
133 pushDebugInfo( tr(
"Python version: %1" ).arg( PYTHON_VERSION ) );
134 pushDebugInfo( tr(
"GDAL version: %1" ).arg( GDALVersionInfo(
"RELEASE_NAME" ) ) );
135 pushDebugInfo( tr(
"GEOS version: %1" ).arg( GEOSversion() ) );
137 const PJ_INFO info = proj_info();
138 pushDebugInfo( tr(
"PROJ version: %1" ).arg( info.release ) );
141#if PDAL_VERSION_MAJOR_INT > 1 || (PDAL_VERSION_MAJOR_INT == 1 && PDAL_VERSION_MINOR_INT >= 7)
142 pushDebugInfo( tr(
"PDAL version: %1" ).arg( QString::fromStdString( pdal::Config::fullVersionString() ) ) );
144 pushDebugInfo( tr(
"PDAL version: %1" ).arg( QString::fromStdString( pdal::GetFullVersionString() ) ) );
148 if ( provider && !provider->
versionInfo().isEmpty() )
156 if ( results.empty() )
164 const QString outputName = output->name();
165 if ( outputName == QLatin1String(
"CHILD_RESULTS" ) || outputName == QLatin1String(
"CHILD_INPUTS" ) )
168 if ( !results.contains( outputName ) )
172 const QString textValue = output->valueAsString( results.value( output->name() ), context, ok );
173 const QString formattedValue = output->valueAsFormattedString( results.value( output->name() ), context, ok );
176 pushFormattedMessage( QStringLiteral(
"<code> %1: %2</code>" ).arg( output->name(), formattedValue ),
177 QStringLiteral(
" %1: %2" ).arg( output->name(), textValue ) );
194 : mChildSteps( childAlgorithmCount )
195 , mFeedback( feedback )
204 mFeedback->
setProgress( 100.0 *
static_cast< double >( mCurrentStep ) / mChildSteps );
257void QgsProcessingMultiStepFeedback::updateOverallProgress(
double progress )
259 const double baseProgress = 100.0 *
static_cast< double >( mCurrentStep ) / mChildSteps;
260 const double currentAlgorithmProgress =
progress / mChildSteps;
261 mFeedback->
setProgress( baseProgress + currentAlgorithmProgress );
static QString version()
Version string.
@ Warning
Warning message.
@ Critical
Critical/error message.
@ Info
Information message.
static QString devVersion()
The development version.
void progressChanged(double progress)
Emitted when the feedback object reports a progress change.
void canceled()
Internal routines can connect to this signal if they use event loop.
void cancel()
Tells the internal routines that the current operation should be canceled. This should be run by the ...
void setProgress(double progress)
Sets the current progress for the feedback object.
double progress() const
Returns the current progress reported by the feedback object.
static void logMessage(const QString &message, const QString &tag=QString(), Qgis::MessageLevel level=Qgis::MessageLevel::Warning, bool notifyUser=true)
Adds a message to the log instance (and creates it if necessary).
Abstract base class for processing algorithms.
QgsProcessingOutputDefinitions outputDefinitions() const
Returns an ordered list of output definitions utilized by the algorithm.
Contains information about the context in which a processing algorithm is executed.
Base class for providing feedback from a processing algorithm.
virtual void pushCommandInfo(const QString &info)
Pushes an informational message containing a command from the algorithm.
virtual void pushInfo(const QString &info)
Pushes a general informational message from the algorithm.
virtual void pushWarning(const QString &warning)
Pushes a warning informational message from the algorithm.
void pushVersionInfo(const QgsProcessingProvider *provider=nullptr)
Pushes a summary of the QGIS (and underlying library) version information to the log.
virtual QString textLog() const
Returns the plain text contents of the log, which contains all messages pushed to the feedback object...
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.
virtual QString htmlLog() const
Returns the HTML formatted contents of the log, which contains all messages pushed to the feedback ob...
virtual void pushDebugInfo(const QString &info)
Pushes an informational message containing debugging helpers from the algorithm.
virtual void pushFormattedMessage(const QString &html, const QString &text)
Pushes a pre-formatted message from the algorithm.
virtual void reportError(const QString &error, bool fatalError=false)
Reports that the algorithm encountered an error while executing.
virtual void pushConsoleInfo(const QString &info)
Pushes a console feedback message from the algorithm.
virtual void setProgressText(const QString &text)
Sets a progress report text string.
QgsProcessingMultiStepFeedback(int steps, QgsProcessingFeedback *feedback)
Constructor for QgsProcessingMultiStepFeedback, for a process with the specified number of steps.
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 pushConsoleInfo(const QString &info) override
Pushes a console feedback 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 setProgressText(const QString &text) override
Sets a progress report text string.
void setCurrentStep(int step)
Sets the step which is being executed.
void reportError(const QString &error, bool fatalError=false) override
Reports that the algorithm encountered an error while executing.
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.
QString htmlLog() const override
Returns the HTML formatted contents of the log, which contains all messages pushed to the feedback ob...
Base class for the definition of processing outputs.
Abstract base class for processing providers.
virtual QString versionInfo() const
Returns a version information string for the provider, or an empty string if this is not applicable (...
virtual QString name() const =0
Returns the provider name, which is used to describe the provider within the GUI.
As part of the API refactoring and improvements which landed in the Processing API was substantially reworked from the x version This was done in order to allow much of the underlying Processing framework to be ported into allowing algorithms to be written in pure substantial changes are required in order to port existing x Processing algorithms for QGIS x The most significant changes are outlined not GeoAlgorithm For algorithms which operate on features one by consider subclassing the QgsProcessingFeatureBasedAlgorithm class This class allows much of the boilerplate code for looping over features from a vector layer to be bypassed and instead requires implementation of a processFeature method Ensure that your algorithm(or algorithm 's parent class) implements the new pure virtual createInstance(self) call