18 #ifndef QGSTASKMANAGER_H
19 #define QGSTASKMANAGER_H
25 #include <QReadWriteLock>
27 #include <QElapsedTimer>
29 #include "qgis_core.h"
33 class QgsTaskRunnableWrapper;
54 class CORE_EXPORT
QgsTask :
public QObject
75 CancelWithoutPrompt = 1 << 2,
79 Q_DECLARE_FLAGS( Flags, Flag )
86 QgsTask(
const QString &description = QString(), QgsTask::Flags flags = AllFlags );
93 Flags
flags()
const {
return mFlags; }
100 void setDescription(
const QString &description );
111 bool isActive()
const {
return mOverallStatus == Running; }
135 qint64 elapsedTime()
const;
146 virtual void cancel();
168 SubTaskIndependent = 0,
193 SubTaskDependency subTaskDependency = SubTaskIndependent );
200 void setDependentLayers(
const QList<QgsMapLayer *> &dependentLayers );
207 QList< QgsMapLayer * > dependentLayers()
const;
218 bool waitForFinished(
int timeout = 30000 );
283 virtual void finished(
bool result ) { Q_UNUSED( result ) }
290 bool isCanceled()
const;
299 void setProgress(
double progress );
302 void subTaskStatusChanged(
int status );
307 QString mDescription;
309 TaskStatus mStatus = Queued;
311 TaskStatus mOverallStatus = Queued;
317 QMutex mNotFinishedMutex;
323 QSemaphore mNotStartedMutex;
326 double mProgress = 0.0;
328 double mTotalProgress = 0.0;
329 bool mShouldTerminate =
false;
330 mutable QMutex mShouldTerminateMutex;
335 SubTask(
QgsTask *task,
const QgsTaskList &dependencies, SubTaskDependency dependency )
337 , dependencies( dependencies )
338 , dependency( dependency )
342 SubTaskDependency dependency;
344 QList< SubTask > mSubTasks;
348 QElapsedTimer mElapsedTime;
367 void processSubTasksForHold();
370 friend class QgsTaskRunnableWrapper;
371 friend class TestQgsTaskManager;
375 void processSubTasksForCompletion();
377 void processSubTasksForTermination();
417 , dependentTasks( dependentTasks )
457 QgsTask *task(
long id )
const;
462 QList<QgsTask *> tasks()
const;
472 long taskId(
QgsTask *task )
const;
482 bool dependenciesSatisfied(
long taskId )
const;
488 QSet< long > dependencies(
long taskId )
const SIP_SKIP;
497 QList< QgsMapLayer * > dependentLayers(
long taskId )
const;
503 QList< QgsTask * > tasksDependentOnLayer(
QgsMapLayer *layer )
const;
509 QList< QgsTask * > activeTasks()
const;
519 int countActiveTasks(
bool includeHidden =
true )
const;
527 void triggerTask(
QgsTask *task );
586 void taskProgressChanged(
double progress );
587 void taskStatusChanged(
int status );
588 void layersWillBeRemoved(
const QList<QgsMapLayer *> &layers );
594 TaskInfo(
QgsTask *task =
nullptr,
int priority = 0 );
595 void createRunnable();
599 QgsTaskRunnableWrapper *runnable =
nullptr;
602 bool mInitialized =
false;
604 #if QT_VERSION < QT_VERSION_CHECK(5, 14, 0)
605 mutable QMutex *mTaskMutex;
607 mutable QRecursiveMutex *mTaskMutex;
610 QMap< long, TaskInfo > mTasks;
611 QMap< long, QgsTaskList > mTaskDependencies;
612 QMap< long, QgsWeakMapLayerPointerList > mLayerDependencies;
615 long mNextTaskId = 1;
618 QSet< QgsTask * > mActiveTasks;
620 QSet< QgsTask * > mParentTasks;
622 QSet< QgsTask * > mSubTasks;
624 QSet< QgsTask * > mPendingDeletion;
626 long addTaskPrivate(
QgsTask *task,
631 bool cleanupAndDeleteTask(
QgsTask *task );
644 void cancelDependentTasks(
long taskId );
646 bool resolveDependencies(
long firstTaskId,
long currentTaskId, QSet< long > &results )
const;
649 bool hasCircularDependencies(
long taskId )
const;
651 friend class TestQgsTaskManager;
Base class for all map layer types.
Task manager for managing a set of long-running QgsTask tasks.
void finalTaskProgressChanged(double progress)
Will be emitted when only a single task remains to complete and that task has reported a progress cha...
void statusChanged(long taskId, int status)
Will be emitted when a task reports a status change.
void taskAdded(long taskId)
Emitted when a new task has been added to the manager.
void taskAboutToBeDeleted(long taskId)
Emitted when a task is about to be deleted.
void allTasksFinished()
Emitted when all tasks are complete.
void progressChanged(long taskId, double progress)
Will be emitted when a task reports a progress change.
void countActiveTasksChanged(int count)
Emitted when the number of active tasks changes.
void taskTriggered(QgsTask *task)
Emitted when a task is triggered.
Abstract base class for long running background tasks.
TaskStatus status() const
Returns the current task status.
Flags flags() const
Returns the flags associated with the task.
void taskCompleted()
Will be emitted by task to indicate its successful completion.
double progress() const
Returns the task's progress (between 0.0 and 100.0)
virtual void finished(bool result)
If the task is managed by a QgsTaskManager, this will be called after the task has finished (whether ...
virtual bool run()=0
Performs the task's operation.
void progressChanged(double progress)
Will be emitted by task when its progress changes.
void begun()
Will be emitted by task to indicate its commencement.
bool isActive() const
Returns true if the task is active, ie it is not complete and has not been canceled.
void taskTerminated()
Will be emitted by task if it has terminated for any reason other then completion (e....
void statusChanged(int status)
Will be emitted by task when its status changes.
TaskStatus
Status of tasks.
@ Terminated
Task was terminated or errored.
@ Queued
Task is queued and has not begun.
@ OnHold
Task is queued but on hold and will not be started.
@ Running
Task is currently running.
@ Complete
Task successfully completed.
QString description() const
Returns the task's description.
SubTaskDependency
Controls how subtasks relate to their parent task.
@ ParentDependsOnSubTask
Subtask must complete before parent can begin.
bool canCancel() const
Returns true if the task can be canceled.
Q_DECLARE_OPERATORS_FOR_FLAGS(QgsField::ConfigurationFlags) CORE_EXPORT QDataStream &operator<<(QDataStream &out
Writes the field to stream out. QGIS version compatibility is not guaranteed.
QList< QgsWeakMapLayerPointer > QgsWeakMapLayerPointerList
A list of weak pointers to QgsMapLayers.
QList< QgsTask * > QgsTaskList
List of QgsTask objects.
Definition of a task for inclusion in the manager.
TaskDefinition(QgsTask *task, const QgsTaskList &dependentTasks=QgsTaskList())
Constructor for TaskDefinition.
QgsTaskList dependentTasks
List of dependent tasks which must be completed before task can run.