QGIS API Documentation 3.27.0-Master (1d7a28cfd2)
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
19#include "qgsapplication.h"
20
21QgsProxyProgressTask::QgsProxyProgressTask( const QString &description, bool canCancel )
22 : QgsTask( description, canCancel ? QgsTask::CanCancel : QgsTask::Flags() )
23{
24}
25
27{
28 const 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
53{
54 emit canceled();
55
57}
58
59//
60// QgsScopedProxyProgressTask
61//
62
64 : mTask( new QgsProxyProgressTask( description ) )
65{
67}
68
70{
71 mTask->finalize( true );
72}
73
75{
76 mTask->setProxyProgress( progress );
77}
static QgsTaskManager * taskManager()
Returns the application's task manager, used for managing application wide background task handling.
A QgsTask shell which proxies progress reports.
void setProxyProgress(double progress)
Sets the progress (from 0 to 100) for the proxied operation.
void finalize(bool result)
Finalizes the task, with the specified result.
void canceled()
Emitted when the task is canceled.
void cancel() override
Notifies the task that it should terminate.
bool run() override
Performs the task's operation.
QgsProxyProgressTask(const QString &description, bool canCancel=false)
Constructor for QgsProxyProgressTask, with the specified description.
void setProgress(double progress)
Sets the progress (from 0 to 100) for the proxied operation.
QgsScopedProxyProgressTask(const QString &description)
Constructor for QgsScopedProxyProgressTask, with the specified description.
long addTask(QgsTask *task, int priority=0)
Adds a task to the manager.
Abstract base class for long running background tasks.
double progress() const
Returns the task's progress (between 0.0 and 100.0)
virtual void cancel()
Notifies the task that it should terminate.