QGIS API Documentation
3.12.1-București (121cc00ff0)
|
QgsTask task which performs a QgsVectorFileWriter layer saving operation as a background task. More...
#include <qgsvectorfilewritertask.h>
Signals | |
void | completed (const QString &newFilename, const QString &newLayer) |
Emitted when writing the layer is successfully completed. More... | |
void | errorOccurred (int error, const QString &errorMessage) |
Emitted when an error occurs which prevented the file being written (or if the task is canceled). More... | |
void | writeComplete (const QString &newFilename) |
Emitted when writing the layer is successfully completed. More... | |
![]() | |
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... | |
Public Member Functions | |
QgsVectorFileWriterTask (QgsVectorLayer *layer, const QString &fileName, const QgsVectorFileWriter::SaveVectorOptions &options) | |
Constructor for QgsVectorFileWriterTask. More... | |
void | cancel () override |
Notifies the task that it should terminate. More... | |
![]() | |
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... | |
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... | |
Protected Member Functions | |
void | finished (bool result) override |
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 | run () override |
Performs the task's operation. More... | |
![]() | |
bool | isCanceled () const |
Will return true if task should terminate ASAP. More... | |
Additional Inherited Members | |
![]() | |
enum | Flag { CanCancel = 1 << 1, 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... | |
![]() | |
void | setProgress (double progress) |
Sets the task's current progress. More... | |
QgsTask task which performs a QgsVectorFileWriter layer saving operation as a background task.
This can be used to save a vector layer out to a file without blocking the QGIS interface.
Definition at line 35 of file qgsvectorfilewritertask.h.
QgsVectorFileWriterTask::QgsVectorFileWriterTask | ( | QgsVectorLayer * | layer, |
const QString & | fileName, | ||
const QgsVectorFileWriter::SaveVectorOptions & | options | ||
) |
Constructor for QgsVectorFileWriterTask.
Takes a source layer, destination fileName and save options.
Definition at line 21 of file qgsvectorfilewritertask.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 47 of file qgsvectorfilewritertask.cpp.
|
signal |
Emitted when writing the layer is successfully completed.
The newFilename parameter indicates the file path for the written file. When applicable, the newLayer parameter indicates the layer name used.
|
signal |
Emitted when an error occurs which prevented the file being written (or if the task is canceled).
The writing error and errorMessage will be reported.
|
overrideprotectedvirtual |
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).
The result argument reflects whether the task was successfully completed or not. This method is always called from the main thread, so it is safe to create widgets and perform other operations which require the main thread. However, the GUI will be blocked for the duration of this method so tasks should avoid performing any lengthy operations here.
Reimplemented from QgsTask.
Definition at line 66 of file qgsvectorfilewritertask.cpp.
|
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 53 of file qgsvectorfilewritertask.cpp.
|
signal |
Emitted when writing the layer is successfully completed.
The newFilename parameter indicates the file path for the written file.