QGIS API Documentation  3.13.0-Master (95f9187dac)
Public Member Functions | List of all members
QgsProxyProgressTask Class Reference

A QgsTask shell which proxies progress reports. More...

#include <qgsproxyprogresstask.h>

Inheritance diagram for QgsProxyProgressTask:
Inheritance graph
[legend]

Public Member Functions

 QgsProxyProgressTask (const QString &description)
 Constructor for QgsProxyProgressTask, with the specified description. More...
 
void finalize (bool result)
 Finalizes the task, with the specified result. More...
 
bool run () override
 Performs the task's operation. More...
 
void setProxyProgress (double progress)
 Sets the progress (from 0 to 100) for the proxied operation. More...
 
- Public Member Functions inherited from QgsTask
 QgsTask (const QString &description=QString(), QgsTask::Flags flags=AllFlags)
 Constructor for QgsTask. More...
 
 ~QgsTask () override
 
void addSubTask (QgsTask *subTask, const QgsTaskList &dependencies=QgsTaskList(), SubTaskDependency subTaskDependency=SubTaskIndependent)
 Adds a subtask to this task. More...
 
bool canCancel () const
 Returns true if the task can be canceled. More...
 
virtual void cancel ()
 Notifies the task that it should terminate. More...
 
QList< QgsMapLayer *> dependentLayers () const
 Returns the list of layers on which the task depends. More...
 
QString description () const
 Returns the task's description. More...
 
qint64 elapsedTime () const
 Returns the elapsed time since the task commenced, in milliseconds. More...
 
Flags flags () const
 Returns the flags associated with the task. More...
 
void hold ()
 Places the task on hold. More...
 
bool isActive () const
 Returns true if the task is active, ie it is not complete and has not been canceled. More...
 
double progress () const
 Returns the task's progress (between 0.0 and 100.0) More...
 
void setDependentLayers (const QList< QgsMapLayer *> &dependentLayers)
 Sets a list of layers on which the task depends. More...
 
void setDescription (const QString &description)
 Sets the task's description. More...
 
TaskStatus status () const
 Returns the current task status. More...
 
void unhold ()
 Releases the task from being held. More...
 
bool waitForFinished (int timeout=30000)
 Blocks the current thread until the task finishes or a maximum of timeout milliseconds. More...
 

Additional Inherited Members

- Public Types inherited from QgsTask
enum  Flag { CanCancel = 1 << 1, CancelWithoutPrompt = 1 << 2, AllFlags = CanCancel }
 Task flags. More...
 
enum  SubTaskDependency { SubTaskIndependent = 0, ParentDependsOnSubTask }
 Controls how subtasks relate to their parent task. More...
 
enum  TaskStatus {
  Queued, OnHold, Running, Complete,
  Terminated
}
 Status of tasks. More...
 
- Signals inherited from QgsTask
void begun ()
 Will be emitted by task to indicate its commencement. More...
 
void progressChanged (double progress)
 Will be emitted by task when its progress changes. More...
 
void statusChanged (int status)
 Will be emitted by task when its status changes. More...
 
void taskCompleted ()
 Will be emitted by task to indicate its successful completion. More...
 
void taskTerminated ()
 Will be emitted by task if it has terminated for any reason other then completion (e.g., when a task has been canceled or encountered an internal error). More...
 
- Protected Slots inherited from QgsTask
void setProgress (double progress)
 Sets the task's current progress. More...
 
- Protected Member Functions inherited from QgsTask
virtual void finished (bool result)
 If the task is managed by a QgsTaskManager, this will be called after the task has finished (whether through successful completion or via early termination). More...
 
bool isCanceled () const
 Will return true if task should terminate ASAP. More...
 

Detailed Description

A QgsTask shell which proxies progress reports.

Simple task shell which runs until finalized and reports progress only. This is usually used to expose a blocking operation's progress via task manager.

Since
QGIS 3.4

Definition at line 35 of file qgsproxyprogresstask.h.

Constructor & Destructor Documentation

◆ QgsProxyProgressTask()

QgsProxyProgressTask::QgsProxyProgressTask ( const QString &  description)

Constructor for QgsProxyProgressTask, with the specified description.

Definition at line 21 of file qgsproxyprogresstask.cpp.

Member Function Documentation

◆ finalize()

void QgsProxyProgressTask::finalize ( bool  result)

Finalizes the task, with the specified result.

This should be called when the operation being proxied has completed, to remove this proxy task from the task manager.

Definition at line 26 of file qgsproxyprogresstask.cpp.

◆ run()

bool QgsProxyProgressTask::run ( )
overridevirtual

Performs the task's operation.

This method will be called when the task commences (ie via calling start() ), and subclasses should implement the operation they wish to perform in the background within this method.

A task must return a boolean value to indicate whether the task was completed successfully or terminated before completion.

Implements QgsTask.

Definition at line 35 of file qgsproxyprogresstask.cpp.

◆ setProxyProgress()

void QgsProxyProgressTask::setProxyProgress ( double  progress)

Sets the progress (from 0 to 100) for the proxied operation.

This method is safe to call from the main thread.

Definition at line 47 of file qgsproxyprogresstask.cpp.


The documentation for this class was generated from the following files: