qgsprocessingbatchalgorithmdialogbase.h

Go to the documentation of this file.

/***************************************************************************
                             qgsprocessingalgorithmdialogbase.h
                             ----------------------------------
    Date                 : November 2017
    Copyright            : (C) 2017 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 QGSPROCESSINGBATCHALGORITHMDIALOGBASE_H
#define QGSPROCESSINGBATCHALGORITHMDIALOGBASE_H
 
#include "qgis.h"
#include "qgis_gui.h"
#include "qgsprocessingalgorithmdialogbase.h"
 
#include <QElapsedTimer>
 
class QgsProcessingBatchFeedback;
class QgsProxyProgressTask;
 
 
 
class GUI_EXPORT QgsProcessingBatchAlgorithmDialogBase : public QgsProcessingAlgorithmDialogBase
{
    Q_OBJECT
 
  public:
 
    QgsProcessingBatchAlgorithmDialogBase( QWidget *parent SIP_TRANSFERTHIS = nullptr, Qt::WindowFlags flags = Qt::WindowFlags() );
    ~QgsProcessingBatchAlgorithmDialogBase() override;
 
    void resetAdditionalGui() override;
    void blockAdditionalControlsWhileRunning() override;
 
  public slots:
 
    virtual void runAsSingle() = 0; // cppcheck-suppress pureVirtualCall
 
  protected slots:
 
    void algExecuted( bool successful, const QVariantMap &results ) override;
 
  protected:
 
    bool isFinalized() override;
 
    void execute( const QList< QVariantMap > &parameters );
 
    virtual QgsProcessingContext *createContext( QgsProcessingFeedback *feedback ) = 0 SIP_FACTORY;
 
    virtual void handleAlgorithmResults( QgsProcessingAlgorithm *algorithm, QgsProcessingContext &context, QgsProcessingFeedback *feedback, const QVariantMap &parameters ) = 0;
 
    virtual void loadHtmlResults( const QVariantMap &results, int index ) = 0;
 
    virtual void createSummaryTable( const QList< QVariantMap > &results, const QList< QVariantMap > &errors ) = 0;
 
  private slots:
 
    void onTaskComplete( bool ok, const QVariantMap &results );
    void taskTriggered( QgsTask *task );
 
  private:
 
    void executeNext();
    void allTasksComplete( bool canceled );
 
    QPushButton *mButtonRunSingle = nullptr;
 
    int mCurrentStep = 0;
    int mTotalSteps = 0;
    QList< QVariantMap > mQueuedParameters;
    QVariantMap mCurrentParameters;
    QPointer< QgsProxyProgressTask > mProxyTask;
    std::unique_ptr< QgsProcessingFeedback > mFeedback;
    std::unique_ptr< QgsProcessingBatchFeedback > mBatchFeedback;
    std::unique_ptr< QgsProcessingContext > mTaskContext;
    QList< QVariantMap > mResults;
    QList< QVariantMap > mErrors;
    QElapsedTimer mTotalTimer;
    QElapsedTimer mCurrentStepTimer;
};
 
 
#endif // QGSPROCESSINGBATCHALGORITHMDIALOGBASE_H