Class: QgsRasterFileWriterTask

class qgis.core.QgsRasterFileWriterTask

Bases: QgsTask

QgsTask task which performs a QgsRasterFileWriter layer saving operation as a background task. This can be used to save a raster layer out to a file without blocking the QGIS interface.

See also

QgsVectorFileExporterTask

New in version 3.0.

QgsRasterFileWriterTask(writer: QgsRasterFileWriter, pipe: QgsRasterPipe, columns: int, rows: int, outputExtent: QgsRectangle, crs: QgsCoordinateReferenceSystem) Constructor for QgsRasterFileWriterTask. Takes a source writer, columns, rows, outputExtent and destination crs. Ownership of the pipe is transferred to the writer task, and will be deleted when the task completes.

Deprecated since version QGIS: 3.8 use version with transformContext instead

QgsRasterFileWriterTask(writer: QgsRasterFileWriter, pipe: QgsRasterPipe, columns: int, rows: int, outputExtent: QgsRectangle, crs: QgsCoordinateReferenceSystem, transformContext: QgsCoordinateTransformContext) Constructor for QgsRasterFileWriterTask. Takes a source writer, columns, rows, outputExtent, destination crs and coordinate transformContext . Ownership of the pipe is transferred to the writer task, and will be deleted when the task completes.

Methods

cancel

childEvent

connectNotify

customEvent

disconnectNotify

finished

param result

isCanceled

Will return True if task should terminate ASAP.

isSignalConnected

receivers

run

rtype

bool

sender

senderSignalIndex

setProgress

Sets the task’s current progress.

timerEvent

Signals

errorOccurred

Emitted when an error occurs which prevented the file being written (or if the task is canceled).

writeComplete

Emitted when writing the layer is successfully completed.

cancel(self)
childEvent(self, QChildEvent)
connectNotify(self, QMetaMethod)
customEvent(self, QEvent)
disconnectNotify(self, QMetaMethod)
errorOccurred

Emitted when an error occurs which prevented the file being written (or if the task is canceled). The writing error will be reported.

Deprecated since version QGIS: 3.10. Use errorOccurred(int, const QString&) [signal]

errorOccurred(self, error: int, errorMessage: str) Emitted when an error occurs which prevented the file being written (or if the task is canceled). The writing error will be reported and a errorMessage will be potentially set.

New in version 3.10: [signal]

Parameters

error (int) –

finished(self, result: bool)
Parameters

result (bool) –

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

Emitted when writing the layer is successfully completed. The outputUrl parameter indicates the file path for the written file(s). [signal]

Parameters

outputUrl (str) –