Class: QgsVectorWarperTask¶
- class qgis.analysis.QgsVectorWarperTask¶
Bases:
QgsTask
A task for warping a vector layer in a background thread.
New in version 3.26.
QgsVectorWarperTask(method: QgsGcpTransformerInterface.TransformMethod, points: Iterable[QgsGcpPoint], destinationCrs:
QgsCoordinateReferenceSystem
, layer:QgsVectorLayer
, fileName: str) Constructor for QgsVectorWarperTask.- Parameters:
method – transformation method
points – GCP point list
destinationCrs – destination layer CRS
layer – source layer
fileName –
filename for destination layer
Enums
Bases:
enum.IntEnum
Methods
Returns the descriptive error message, if an error occurred.
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).Will return
True
if task should terminate ASAP.Returns the result of running the task.
- rtype:
bool
Sets the task's current progress.
- class Result(value)¶
Bases:
enum.IntEnum
Task results
Success
: Warping completed successfullyCanceled
: Task was canceled before completionError
: An error occurred while warping
- Canceled = 1¶
- Error = 2¶
- Success = 0¶
- cancel(self)¶
- childEvent(self, QChildEvent)¶
- connectNotify(self, QMetaMethod)¶
- customEvent(self, QEvent)¶
- disconnectNotify(self, QMetaMethod)¶
- errorMessage(self) str ¶
Returns the descriptive error message, if an error occurred.
- Return type:
str
- finished(self, result: bool)¶
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.
- isCanceled(self) bool ¶
Will return
True
if task should terminate ASAP. If the task reports the CanCancel flag, then derived classes’run()
methods should periodically check this and terminate in a safe manner.
- isSignalConnected(self, QMetaMethod) bool ¶
- receivers(self, PYQT_SIGNAL) int ¶
- result(self) QgsVectorWarperTask.Result ¶
Returns the result of running the task.
- Return type:
- run(self) bool ¶
- Return type:
bool
- sender(self) QObject ¶
- senderSignalIndex(self) int ¶
- setProgress(self, progress: float)¶
Sets the task’s current progress. The derived class should call this method whenever the task wants to update its progress. Calling will automatically emit the progressChanged signal.
- Parameters:
progress – percent of progress, from 0.0 - 100.0
- timerEvent(self, QTimerEvent)¶