qgsproxyprogresstask.h

Go to the documentation of this file.

/***************************************************************************
                             qgsproxyprogresstask.h
                             ----------------------
    begin                : August 2018
    copyright            : (C) 2018 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 QGSPROXYPROGRESSTASK_H
#define QGSPROXYPROGRESSTASK_H
 
#include "qgstaskmanager.h"
#include "qgsvirtuallayerdefinition.h"
 
#include <QWaitCondition>

class CORE_EXPORT QgsProxyProgressTask : public QgsTask
{
    Q_OBJECT
 
  public:
    QgsProxyProgressTask( const QString &description, bool canCancel = false );
 
    QgsProxyProgressTask( const QgsProxyProgressTask &other ) = delete;
    QgsProxyProgressTask &operator=( const QgsProxyProgressTask &other ) = delete;

    void finalize( bool result );
 
    bool run() override;

    void setProxyProgress( double progress );
 
    void cancel() override;
 
  signals:

    void canceled();
 
  private:
    QWaitCondition mNotFinishedWaitCondition;
    QMutex mNotFinishedMutex;
    bool mAlreadyFinished = false;
    bool mResult = true;
};

class CORE_EXPORT QgsScopedProxyProgressTask
{
  public:
    QgsScopedProxyProgressTask( const QString &description );
 
    QgsScopedProxyProgressTask( const QgsScopedProxyProgressTask &other ) = delete;
    QgsScopedProxyProgressTask &operator=( const QgsScopedProxyProgressTask &other ) = delete;
 
    ~QgsScopedProxyProgressTask();

    void setProgress( double progress );
 
  private:
    QgsProxyProgressTask *mTask = nullptr;
 
#ifdef SIP_RUN
    QgsScopedProxyProgressTask( const QgsScopedProxyProgressTask &other );
#endif
 
    // SIP generates .cpp code that doesn't compile if commenting out the legit following line.
    // Q_DISABLE_COPY( QgsScopedProxyProgressTask )
};
 
#endif // QGSPROXYPROGRESSTASK_H