QGIS API Documentation  3.27.0-Master (aef1b1ec20)
Public Member Functions | List of all members
QgsRasterBlockFeedback Class Reference

Feedback object tailored for raster block reading. More...

#include <qgsrasterinterface.h>

Inheritance diagram for QgsRasterBlockFeedback:
Inheritance graph
[legend]

Public Member Functions

 QgsRasterBlockFeedback (QObject *parent=nullptr)
 Construct a new raster block feedback object. More...
 
void appendError (const QString &error)
 Appends an error message to the stored list of errors. More...
 
QStringList errors () const
 Returns a list of any errors encountered while retrieving the raster block. More...
 
bool isPreviewOnly () const
 Whether the raster provider should return only data that are already available without waiting for full result. More...
 
virtual void onNewData ()
 May be emitted by raster data provider to indicate that some partial data are available and a new preview image may be produced. More...
 
QgsRenderContext renderContext () const
 Returns the render context of the associated block reading. More...
 
bool renderPartialOutput () const
 Whether our painter is drawing to a temporary image used just by this layer. More...
 
void setPreviewOnly (bool preview)
 set flag whether the block request is for preview purposes only More...
 
void setRenderContext (const QgsRenderContext &renderContext)
 Sets the render context of the associated block reading. More...
 
void setRenderPartialOutput (bool enable)
 Set whether our painter is drawing to a temporary image used just by this layer. More...
 
- Public Member Functions inherited from QgsFeedback
 QgsFeedback (QObject *parent=nullptr)
 Construct a feedback object. More...
 
bool isCanceled () const SIP_HOLDGIL
 Tells whether the operation has been canceled already. More...
 
unsigned long long processedCount () const SIP_HOLDGIL
 Returns the current processed objects count reported by the feedback object. More...
 
double progress () const SIP_HOLDGIL
 Returns the current progress reported by the feedback object. More...
 
void setProcessedCount (unsigned long long processedCount)
 Sets the current processed objects count for the feedback object. More...
 
void setProgress (double progress)
 Sets the current progress for the feedback object. More...
 

Additional Inherited Members

- Public Slots inherited from QgsFeedback
void cancel ()
 Tells the internal routines that the current operation should be canceled. This should be run by the main thread. More...
 
- Signals inherited from QgsFeedback
void canceled ()
 Internal routines can connect to this signal if they use event loop. More...
 
void processedCountChanged (unsigned long long processedCount)
 Emitted when the feedback object reports a change in the number of processed objects. More...
 
void progressChanged (double progress)
 Emitted when the feedback object reports a progress change. More...
 

Detailed Description

Feedback object tailored for raster block reading.

Since
QGIS 3.0

Definition at line 41 of file qgsrasterinterface.h.

Constructor & Destructor Documentation

◆ QgsRasterBlockFeedback()

QgsRasterBlockFeedback::QgsRasterBlockFeedback ( QObject *  parent = nullptr)
inline

Construct a new raster block feedback object.

Definition at line 47 of file qgsrasterinterface.h.

Member Function Documentation

◆ appendError()

void QgsRasterBlockFeedback::appendError ( const QString &  error)
inline

Appends an error message to the stored list of errors.

Should be called whenever an error is encountered while retrieving a raster block.

See also
errors()
Since
QGIS 3.8.0

Definition at line 87 of file qgsrasterinterface.h.

◆ errors()

QStringList QgsRasterBlockFeedback::errors ( ) const
inline

Returns a list of any errors encountered while retrieving the raster block.

See also
appendError()
Since
QGIS 3.8.0

Definition at line 95 of file qgsrasterinterface.h.

◆ isPreviewOnly()

bool QgsRasterBlockFeedback::isPreviewOnly ( ) const
inline

Whether the raster provider should return only data that are already available without waiting for full result.

By default this flag is not enabled.

See also
setPreviewOnly()

Definition at line 60 of file qgsrasterinterface.h.

◆ onNewData()

virtual void QgsRasterBlockFeedback::onNewData ( )
inlinevirtual

May be emitted by raster data provider to indicate that some partial data are available and a new preview image may be produced.

Definition at line 53 of file qgsrasterinterface.h.

◆ renderContext()

QgsRenderContext QgsRasterBlockFeedback::renderContext ( ) const

Returns the render context of the associated block reading.

See also
setRenderContext()
Since
QGIS 3.24.0

Definition at line 647 of file qgsrasterinterface.cpp.

◆ renderPartialOutput()

bool QgsRasterBlockFeedback::renderPartialOutput ( ) const
inline

Whether our painter is drawing to a temporary image used just by this layer.

See also
setRenderPartialOutput()

Definition at line 72 of file qgsrasterinterface.h.

◆ setPreviewOnly()

void QgsRasterBlockFeedback::setPreviewOnly ( bool  preview)
inline

set flag whether the block request is for preview purposes only

See also
isPreviewOnly()

Definition at line 66 of file qgsrasterinterface.h.

◆ setRenderContext()

void QgsRasterBlockFeedback::setRenderContext ( const QgsRenderContext renderContext)

Sets the render context of the associated block reading.

See also
renderContext()
Since
QGIS 3.24.0

Definition at line 652 of file qgsrasterinterface.cpp.

◆ setRenderPartialOutput()

void QgsRasterBlockFeedback::setRenderPartialOutput ( bool  enable)
inline

Set whether our painter is drawing to a temporary image used just by this layer.

See also
renderPartialOutput()

Definition at line 78 of file qgsrasterinterface.h.


The documentation for this class was generated from the following files: