qgsprocessingalgrunnertask.h

Go to the documentation of this file.

/***************************************************************************
                         qgsprocessingalgrunnertask.h
                         ------------------------
    begin                : May 2017
    copyright            : (C) 2017 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 QGSPROCESSINGALGRUNNERTASK_H
#define QGSPROCESSINGALGRUNNERTASK_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgsprocessingalgorithm.h"
#include "qgsprocessingfeedback.h"
#include "qgstaskmanager.h"
 
class QgsProcessingContext;

class CORE_EXPORT QgsProcessingAlgRunnerTask : public QgsTask
{
    Q_OBJECT
 
  public:

    QgsProcessingAlgRunnerTask( const QgsProcessingAlgorithm *algorithm,
                                const QVariantMap &parameters,
                                QgsProcessingContext &context,
                                QgsProcessingFeedback *feedback = nullptr,
                                QgsTask::Flags flags = QgsTask::CanCancel );
 
    void cancel() override;

    bool algorithmCanceled() { return isCanceled(); }
 
  signals:

    void executed( bool successful, const QVariantMap &results );
 
  protected:
 
    bool run() override;
    void finished( bool result ) override;
 
  private:
 
    QVariantMap mParameters;
    QVariantMap mResults;
    QgsProcessingContext &mContext;
    QgsProcessingFeedback *mFeedback = nullptr;
    std::unique_ptr< QgsProcessingFeedback > mOwnedFeedback;
    std::unique_ptr< QgsProcessingAlgorithm > mAlgorithm;
 
};
 
#endif // QGSPROCESSINGALGRUNNERTASK_H