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

#include <qgsproxyprogresstask.h>

Inheritance diagram for QgsProxyProgressTask:

[legend]

Signals
void	canceled ()
	Emitted when the task is canceled.

Signals inherited from QgsTask
void	begun ()
	Will be emitted by task to indicate its commencement.

void	progressChanged (double progress)
	Will be emitted by task when its progress changes.

void	statusChanged (int status)
	Will be emitted by task when its status changes.

void	taskCompleted ()
	Will be emitted by task to indicate its successful completion.

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).

Public Member Functions
	QgsProxyProgressTask (const QgsProxyProgressTask &other)=delete

	QgsProxyProgressTask (const QString &description, bool canCancel=false)
	Constructor for QgsProxyProgressTask, with the specified description.

void	cancel () override
	Notifies the task that it should terminate.

void	finalize (bool result)
	Finalizes the task, with the specified result.

QgsProxyProgressTask &	operator= (const QgsProxyProgressTask &other)=delete

bool	run () override
	Performs the task's operation.

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

Public Member Functions inherited from QgsTask
	QgsTask (const QString &description=QString(), QgsTask::Flags flags=AllFlags)
	Constructor for QgsTask.

	~QgsTask () override

void	addSubTask (QgsTask *subTask, const QgsTaskList &dependencies=QgsTaskList(), SubTaskDependency subTaskDependency=SubTaskIndependent)
	Adds a subtask to this task.

bool	canCancel () const
	Returns `true` if the task can be canceled.

QList< QgsMapLayer * >	dependentLayers () const
	Returns the list of layers on which the task depends.

QString	description () const
	Returns the task's description.

qint64	elapsedTime () const
	Returns the elapsed time since the task commenced, in milliseconds.

Flags	flags () const
	Returns the flags associated with the task.

void	hold ()
	Places the task on hold.

bool	isActive () const
	Returns `true` if the task is active, ie it is not complete and has not been canceled.

double	progress () const
	Returns the task's progress (between 0.0 and 100.0)

void	setDependentLayers (const QList< QgsMapLayer * > &dependentLayers)
	Sets a list of layers on which the task depends.

void	setDescription (const QString &description)
	Sets the task's description.

TaskStatus	status () const
	Returns the current task status.

void	unhold ()
	Releases the task from being held.

bool	waitForFinished (int timeout=30000)
	Blocks the current thread until the task finishes or a maximum of timeout milliseconds.

Additional Inherited Members
Public Types inherited from QgsTask
enum	Flag { CanCancel = 1 << 1 , CancelWithoutPrompt = 1 << 2 , Hidden = 1 << 3 , Silent = 1 << 4 , AllFlags = CanCancel }
	Task flags. More...

typedef QFlags< Flag >	Flags

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...

Protected Slots inherited from QgsTask
void	setProgress (double progress)
	Sets the task's current progress.

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).

bool	isCanceled () const
	Will return `true` if task should terminate ASAP.

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 37 of file qgsproxyprogresstask.h.

Constructor & Destructor Documentation

◆ QgsProxyProgressTask() [1/2]

QgsProxyProgressTask::QgsProxyProgressTask	(	const QString &	description,
		bool	canCancel = `false`
	)

Constructor for QgsProxyProgressTask, with the specified description.

Definition at line 23 of file qgsproxyprogresstask.cpp.

◆ QgsProxyProgressTask() [2/2]

QgsProxyProgressTask::QgsProxyProgressTask ( const QgsProxyProgressTask & other )

delete

Member Function Documentation

◆ cancel()

void QgsProxyProgressTask::cancel ( )

overridevirtual

Notifies the task that it should terminate.

Calling this is not guaranteed to immediately end the task, rather it sets the isCanceled() flag which task subclasses can check and terminate their operations at an appropriate time. Any subtasks owned by this task will also be canceled. Derived classes must ensure that the base class implementation is called from any overridden version.

See also: isCanceled()

Reimplemented from QgsTask.

Definition at line 56 of file qgsproxyprogresstask.cpp.

◆ canceled

void QgsProxyProgressTask::canceled ( )

signal

Emitted when the task is canceled.

Since: QGIS 3.26

◆ 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 28 of file qgsproxyprogresstask.cpp.

◆ operator=()

QgsProxyProgressTask & QgsProxyProgressTask::operator= ( const QgsProxyProgressTask & other )

delete

◆ 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 37 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 51 of file qgsproxyprogresstask.cpp.

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

/build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/core/qgsproxyprogresstask.h
/build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/core/qgsproxyprogresstask.cpp

Signals

Public Member Functions

Additional Inherited Members