QGIS API Documentation  3.13.0-Master (9729a43df7)
qgsproxyprogresstask.cpp
Go to the documentation of this file.
1 /***************************************************************************
2  qgsproxyprogresstask.cpp
3  ------------------------
4  begin : August 2018
5  copyright : (C) 2018 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 #include "qgsproxyprogresstask.h"
19 #include "qgsapplication.h"
20 
21 QgsProxyProgressTask::QgsProxyProgressTask( const QString &description )
22  : QgsTask( description, QgsTask::Flags() )
23 {
24 }
25 
26 void QgsProxyProgressTask::finalize( bool result )
27 {
28  QMutexLocker lock( &mNotFinishedMutex );
29  mAlreadyFinished = true;
30 
31  mResult = result;
32  mNotFinishedWaitCondition.wakeAll();
33 }
34 
36 {
37  mNotFinishedMutex.lock();
38  if ( !mAlreadyFinished )
39  {
40  mNotFinishedWaitCondition.wait( &mNotFinishedMutex );
41  }
42  mNotFinishedMutex.unlock();
43 
44  return mResult;
45 }
46 
48 {
49  QMetaObject::invokeMethod( this, "setProgress", Qt::AutoConnection, Q_ARG( double, progress ) );
50 }
51 
52 //
53 // QgsScopedProxyProgressTask
54 //
55 
57  : mTask( new QgsProxyProgressTask( description ) )
58 {
60 }
61 
63 {
64  mTask->finalize( true );
65 }
66 
68 {
69  mTask->setProxyProgress( progress );
70 }
void setProxyProgress(double progress)
Sets the progress (from 0 to 100) for the proxied operation.
static QgsTaskManager * taskManager()
Returns the application's task manager, used for managing application wide background task handling...
QString description() const
Returns the task's description.
long addTask(QgsTask *task, int priority=0)
Adds a task to the manager.
Abstract base class for long running background tasks.
bool run() override
Performs the task's operation.
double progress() const
Returns the task's progress (between 0.0 and 100.0)
void setProgress(double progress)
Sets the progress (from 0 to 100) for the proxied operation.
QgsProxyProgressTask(const QString &description)
Constructor for QgsProxyProgressTask, with the specified description.
QgsScopedProxyProgressTask(const QString &description)
Constructor for QgsScopedProxyProgressTask, with the specified description.
A QgsTask shell which proxies progress reports.
void finalize(bool result)
Finalizes the task, with the specified result.