QGIS API Documentation 3.39.0-Master (132cbd6f1b5)
|
A task for warping a vector layer in a background thread. More...
#include <qgsvectorwarper.h>
Public Types | |
enum class | Result { Success , Canceled , Error } |
Task results. More... | |
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... | |
Public Member Functions | |
QgsVectorWarperTask (QgsGcpTransformerInterface::TransformMethod method, const QList< QgsGcpPoint > &points, const QgsCoordinateReferenceSystem &destinationCrs, QgsVectorLayer *layer, const QString &fileName) | |
Constructor for QgsVectorWarperTask. | |
void | cancel () override |
Notifies the task that it should terminate. | |
QString | errorMessage () const |
Returns the descriptive error message, if an error occurred. | |
Result | result () const |
Returns the result of running the task. | |
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. | |
Protected Member Functions | |
bool | run () override |
Performs the task's operation. | |
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. | |
Additional Inherited Members | |
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). | |
Protected Slots inherited from QgsTask | |
void | setProgress (double progress) |
Sets the task's current progress. | |
A task for warping a vector layer in a background thread.
Definition at line 81 of file qgsvectorwarper.h.
|
strong |
Task results.
Enumerator | |
---|---|
Success | Warping completed successfully. |
Canceled | Task was canceled before completion. |
Error | An error occurred while warping. |
Definition at line 104 of file qgsvectorwarper.h.
QgsVectorWarperTask::QgsVectorWarperTask | ( | QgsGcpTransformerInterface::TransformMethod | method, |
const QList< QgsGcpPoint > & | points, | ||
const QgsCoordinateReferenceSystem & | destinationCrs, | ||
QgsVectorLayer * | layer, | ||
const QString & | fileName | ||
) |
Constructor for QgsVectorWarperTask.
method | transformation method |
points | GCP point list |
destinationCrs | destination layer CRS |
layer | source layer |
fileName | filename for destination layer |
Definition at line 95 of file qgsvectorwarper.cpp.
|
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.
Reimplemented from QgsTask.
Definition at line 114 of file qgsvectorwarper.cpp.
|
inline |
Returns the descriptive error message, if an error occurred.
Definition at line 119 of file qgsvectorwarper.h.
|
inline |
Returns the result of running the task.
Definition at line 114 of file qgsvectorwarper.h.
|
overrideprotectedvirtual |
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 122 of file qgsvectorwarper.cpp.