Class: QgsRasterFileWriterTask

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

Bases: qgis._core.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.

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: Enums

Methods

cancel
childEvent
connectNotify
customEvent
disconnectNotify
finished
isCanceled
isSignalConnected
receivers
run
sender
senderSignalIndex
setProgress
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.

Attributes

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. [signal]

finished(self, result: bool)
isCanceled()
isSignalConnected()
receivers()
run(self) → 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]