qgsprocessingfeedback.h

Go to the documentation of this file.

/***************************************************************************
                         qgsprocessingfeedback.h
                         -----------------------
    begin                : December 2016
    copyright            : (C) 2016 by Nyall Dawson
    email                : nyall dot dawson at gmail dot com
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSPROCESSINGFEEDBACK_H
#define QGSPROCESSINGFEEDBACK_H
 
#include "qgis_core.h"
#include "qgsfeedback.h"
 
#include <QMap>
 
class QgsProcessingProvider;
class QgsProcessingAlgorithm;
class QgsProcessingContext;

class CORE_EXPORT QgsProcessingFeedback : public QgsFeedback
{
    Q_OBJECT
 
  public:
    QgsProcessingFeedback( bool logFeedback = true );

    virtual void setProgressText( const QString &text );

    virtual void reportError( const QString &error, bool fatalError = false );

    virtual void pushWarning( const QString &warning );

    virtual void pushInfo( const QString &info );

    virtual void pushFormattedMessage( const QString &html, const QString &text );

    virtual void pushCommandInfo( const QString &info );

    virtual void pushDebugInfo( const QString &info );

    virtual void pushConsoleInfo( const QString &info );

    void pushVersionInfo( const QgsProcessingProvider *provider = nullptr );

    void pushFormattedResults( const QgsProcessingAlgorithm *algorithm, QgsProcessingContext &context, const QVariantMap &results );

    virtual QString htmlLog() const;

    virtual QString textLog() const;

    void reportSourceLoaded( const QString &parameterName, long long featureCount );

    void featureAddedToSink( const QString &output );

    void featureSinkFinalized( const QString &output );

    void resetFeatureSinkCounts();
 
  signals:

    void progressTextChanged( const QString &text );

    void errorReported( const QString &text, bool fatalError );

    void warningPushed( const QString &text );

    void infoPushed( const QString &text );

    void commandInfoPushed( const QString &text );

    void debugInfoPushed( const QString &text );

    void consoleInfoPushed( const QString &text );

    void formattedMessagePushed( const QString &html );

    void sinkFeatureCountChanged( const QString &output, long long featureCount );

    void sourceLoaded( const QString &parameterName, long long featureCount );
 
  private:
    void log( const QString &htmlMessage, const QString &textMessage );
 
    bool mLogFeedback = true;
    QString mHtmlLog;
    QString mTextLog;
    int mMessageLoggedCount = 0;
 
    struct SinkStats
    {
        long long featureCount = 0;
        long long countAtLastSignal = 0;
    };
 
    QMap< QString, SinkStats > mSinkFeatureCounts;
};
 

class CORE_EXPORT QgsProcessingMultiStepFeedback : public QgsProcessingFeedback
{
    Q_OBJECT
 
  public:
    QgsProcessingMultiStepFeedback( int steps, QgsProcessingFeedback *feedback );

    void setCurrentStep( int step );

    void setStepWeights( const QList<double> &weights );
 
    void setProgressText( const QString &text ) override;
    void reportError( const QString &error, bool fatalError = false ) override;
    void pushWarning( const QString &warning ) override;
    void pushInfo( const QString &info ) override;
    void pushCommandInfo( const QString &info ) override;
    void pushDebugInfo( const QString &info ) override;
    void pushConsoleInfo( const QString &info ) override;
    void pushFormattedMessage( const QString &html, const QString &text ) override;
 
    QString htmlLog() const override;
    QString textLog() const override;
 
  private slots:
 
    void updateOverallProgress( double progress );
 
  private:
    int mChildSteps = 0;
    int mCurrentStep = 0;
    QList< double > mStepWeights;
    double mCurrentStepBaseProgress = 0.0;
    QgsProcessingFeedback *mFeedback = nullptr;
};
 
#endif // QGSPROCESSINGFEEDBACK_H