Class: QgsRasterFileWriterTask

class qgis.core.QgsRasterFileWriterTask(writer: QgsRasterFileWriter, pipe: QgsRasterPipe, columns: int, rows: int, outputExtent: QgsRectangle, crs: QgsCoordinateReferenceSystem)

Bases: QgsTask

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.

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.

Parameters
cancel(self)
childEvent()
connectNotify()
customEvent()
disconnectNotify()
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()
isSignalConnected()
receivers()
run(self) → bool
Return type

bool

sender()
senderSignalIndex()
setProgress()
timerEvent()
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) –