Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                          qgsprocessingalgrunnertask.h
       3                 :            :                          ------------------------
       4                 :            :     begin                : May 2017
       5                 :            :     copyright            : (C) 2017 by Nyall Dawson
       6                 :            :     email                : nyall dot dawson at gmail dot com
       7                 :            :  ***************************************************************************/
       8                 :            : 
       9                 :            : /***************************************************************************
      10                 :            :  *                                                                         *
      11                 :            :  *   This program is free software; you can redistribute it and/or modify  *
      12                 :            :  *   it under the terms of the GNU General Public License as published by  *
      13                 :            :  *   the Free Software Foundation; either version 2 of the License, or     *
      14                 :            :  *   (at your option) any later version.                                   *
      15                 :            :  *                                                                         *
      16                 :            :  ***************************************************************************/
      17                 :            : 
      18                 :            : #ifndef QGSPROCESSINGALGRUNNERTASK_H
      19                 :            : #define QGSPROCESSINGALGRUNNERTASK_H
      20                 :            : 
      21                 :            : #include "qgis_core.h"
      22                 :            : #include "qgis.h"
      23                 :            : #include "qgstaskmanager.h"
      24                 :            : #include "qgsprocessingfeedback.h"
      25                 :            : #include "qgsprocessingalgorithm.h"
      26                 :            : 
      27                 :            : class QgsProcessingContext;
      28                 :            : 
      29                 :            : /**
      30                 :            :  * \class QgsProcessingAlgRunnerTask
      31                 :            :  * \ingroup core
      32                 :            :  * \brief QgsTask task which runs a QgsProcessingAlgorithm in a background task.
      33                 :            :  * \since QGIS 3.0
      34                 :            :  */
      35                 :            : class CORE_EXPORT QgsProcessingAlgRunnerTask : public QgsTask
      36                 :            : {
      37                 :          0 :     Q_OBJECT
      38                 :            : 
      39                 :            :   public:
      40                 :            : 
      41                 :            :     /**
      42                 :            :      * Constructor for QgsProcessingAlgRunnerTask. Takes an \a algorithm, algorithm \a parameters
      43                 :            :      * and processing \a context.
      44                 :            :      */
      45                 :            :     QgsProcessingAlgRunnerTask( const QgsProcessingAlgorithm *algorithm,
      46                 :            :                                 const QVariantMap &parameters,
      47                 :            :                                 QgsProcessingContext &context,
      48                 :            :                                 QgsProcessingFeedback *feedback = nullptr );
      49                 :            : 
      50                 :            :     void cancel() override;
      51                 :            : 
      52                 :            :   signals:
      53                 :            : 
      54                 :            :     /**
      55                 :            :      * Emitted when the algorithm has finished execution. If the algorithm completed
      56                 :            :      * execution without errors then \a successful will be TRUE. The \a results argument
      57                 :            :      * contains the results reported by the algorithm.
      58                 :            :      */
      59                 :            :     void executed( bool successful, const QVariantMap &results );
      60                 :            : 
      61                 :            :   protected:
      62                 :            : 
      63                 :            :     bool run() override;
      64                 :            :     void finished( bool result ) override;
      65                 :            : 
      66                 :            :   private:
      67                 :            : 
      68                 :            :     QVariantMap mParameters;
      69                 :            :     QVariantMap mResults;
      70                 :            :     QgsProcessingContext &mContext;
      71                 :            :     QgsProcessingFeedback *mFeedback = nullptr;
      72                 :            :     std::unique_ptr< QgsProcessingFeedback > mOwnedFeedback;
      73                 :            :     std::unique_ptr< QgsProcessingAlgorithm > mAlgorithm;
      74                 :            : 
      75                 :            : };
      76                 :            : 
      77                 :            : #endif // QGSPROCESSINGALGRUNNERTASK_H
      78                 :            : 
      79                 :            :