QGIS API Documentation 3.27.0-Master (1c05421486)
Public Member Functions | Friends | List of all members
QgsRasterLayerProfileGenerator Class Reference

Implementation of QgsAbstractProfileGenerator for raster layers. More...

#include <qgsrasterlayerprofilegenerator.h>

Inheritance diagram for QgsRasterLayerProfileGenerator:
Inheritance graph
[legend]

Public Member Functions

 QgsRasterLayerProfileGenerator (QgsRasterLayer *layer, const QgsProfileRequest &request)
 Constructor for QgsRasterLayerProfileGenerator. More...
 
 ~QgsRasterLayerProfileGenerator () override
 
QgsFeedbackfeedback () const override
 Access to feedback object of the generator (may be nullptr) More...
 
Qgis::ProfileGeneratorFlags flags () const override
 Returns flags which reflect how the profile generator operates. More...
 
bool generateProfile (const QgsProfileGenerationContext &context=QgsProfileGenerationContext()) override
 Generate the profile (based on data stored in the class). More...
 
QString sourceId () const override
 Returns a unique identifier representing the source of the profile. More...
 
QgsAbstractProfileResultstakeResults () override
 Takes results from the generator. More...
 
- Public Member Functions inherited from QgsAbstractProfileSurfaceGenerator
 ~QgsAbstractProfileSurfaceGenerator () override
 
QgsFillSymbolfillSymbol () const
 Returns the fill symbol to be used for rendering the results. More...
 
QgsLineSymbollineSymbol () const
 Returns the line symbol to be used for rendering the results. More...
 
Qgis::ProfileSurfaceSymbology symbology () const
 Returns the symbology type for rendering the results. More...
 
- Public Member Functions inherited from QgsAbstractProfileGenerator
virtual ~QgsAbstractProfileGenerator ()
 
virtual QgsFeedbackfeedback () const =0
 Access to feedback object of the generator (may be nullptr) More...
 
virtual Qgis::ProfileGeneratorFlags flags () const
 Returns flags which reflect how the profile generator operates. More...
 
virtual bool generateProfile (const QgsProfileGenerationContext &context=QgsProfileGenerationContext())=0
 Generate the profile (based on data stored in the class). More...
 
virtual QString sourceId () const =0
 Returns a unique identifier representing the source of the profile. More...
 
virtual QgsAbstractProfileResultstakeResults ()=0
 Takes results from the generator. More...
 

Friends

class QgsRasterLayerProfileResults
 

Additional Inherited Members

- Protected Attributes inherited from QgsAbstractProfileSurfaceGenerator
std::unique_ptr< QgsFillSymbolmFillSymbol
 
std::unique_ptr< QgsLineSymbolmLineSymbol
 
Qgis::ProfileSurfaceSymbology mSymbology = Qgis::ProfileSurfaceSymbology::Line
 

Detailed Description

Implementation of QgsAbstractProfileGenerator for raster layers.

Note
Not available in Python bindings
Since
QGIS 3.26

Definition at line 67 of file qgsrasterlayerprofilegenerator.h.

Constructor & Destructor Documentation

◆ QgsRasterLayerProfileGenerator()

QgsRasterLayerProfileGenerator::QgsRasterLayerProfileGenerator ( QgsRasterLayer layer,
const QgsProfileRequest request 
)

Constructor for QgsRasterLayerProfileGenerator.

Definition at line 61 of file qgsrasterlayerprofilegenerator.cpp.

◆ ~QgsRasterLayerProfileGenerator()

QgsRasterLayerProfileGenerator::~QgsRasterLayerProfileGenerator ( )
overridedefault

Member Function Documentation

◆ feedback()

QgsFeedback * QgsRasterLayerProfileGenerator::feedback ( ) const
overridevirtual

Access to feedback object of the generator (may be nullptr)

Implements QgsAbstractProfileGenerator.

Definition at line 352 of file qgsrasterlayerprofilegenerator.cpp.

◆ flags()

Qgis::ProfileGeneratorFlags QgsRasterLayerProfileGenerator::flags ( ) const
overridevirtual

Returns flags which reflect how the profile generator operates.

Reimplemented from QgsAbstractProfileGenerator.

Definition at line 88 of file qgsrasterlayerprofilegenerator.cpp.

◆ generateProfile()

bool QgsRasterLayerProfileGenerator::generateProfile ( const QgsProfileGenerationContext context = QgsProfileGenerationContext())
overridevirtual

Generate the profile (based on data stored in the class).

Returns true if the profile was generated successfully (i.e. the generation was not canceled early).

Implements QgsAbstractProfileGenerator.

Definition at line 95 of file qgsrasterlayerprofilegenerator.cpp.

◆ sourceId()

QString QgsRasterLayerProfileGenerator::sourceId ( ) const
overridevirtual

Returns a unique identifier representing the source of the profile.

For generators associated with a map layer the source ID will match the layer's QgsMapLayer::id(). Other (non-map-layer) sources will have a different unique ID with its own custom interpretation.gen

Implements QgsAbstractProfileGenerator.

Definition at line 83 of file qgsrasterlayerprofilegenerator.cpp.

◆ takeResults()

QgsAbstractProfileResults * QgsRasterLayerProfileGenerator::takeResults ( )
overridevirtual

Takes results from the generator.

Ownership is transferred to the caller.

Implements QgsAbstractProfileGenerator.

Definition at line 347 of file qgsrasterlayerprofilegenerator.cpp.

Friends And Related Function Documentation

◆ QgsRasterLayerProfileResults

friend class QgsRasterLayerProfileResults
friend

Definition at line 109 of file qgsrasterlayerprofilegenerator.h.


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