QGIS API Documentation 3.27.0-Master (95e00c50d2)
Public Member Functions | Friends | List of all members
QgsVectorLayerProfileGenerator Class Reference

Implementation of QgsAbstractProfileGenerator for vector layers. More...

#include <qgsvectorlayerprofilegenerator.h>

Inheritance diagram for QgsVectorLayerProfileGenerator:
Inheritance graph
[legend]

Public Member Functions

 QgsVectorLayerProfileGenerator (QgsVectorLayer *layer, const QgsProfileRequest &request)
 Constructor for QgsVectorLayerProfileGenerator. More...
 
 ~QgsVectorLayerProfileGenerator () override
 
QgsFeedbackfeedback () const override
 Access to feedback object of the generator (may be nullptr) 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 QgsVectorLayerProfileResults
 

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 vector layers.

Note
Not available in Python bindings
Since
QGIS 3.26

Definition at line 102 of file qgsvectorlayerprofilegenerator.h.

Constructor & Destructor Documentation

◆ QgsVectorLayerProfileGenerator()

QgsVectorLayerProfileGenerator::QgsVectorLayerProfileGenerator ( QgsVectorLayer layer,
const QgsProfileRequest request 
)

Constructor for QgsVectorLayerProfileGenerator.

Definition at line 616 of file qgsvectorlayerprofilegenerator.cpp.

◆ ~QgsVectorLayerProfileGenerator()

QgsVectorLayerProfileGenerator::~QgsVectorLayerProfileGenerator ( )
overridedefault

Member Function Documentation

◆ feedback()

QgsFeedback * QgsVectorLayerProfileGenerator::feedback ( ) const
overridevirtual

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

Implements QgsAbstractProfileGenerator.

Definition at line 728 of file qgsvectorlayerprofilegenerator.cpp.

◆ generateProfile()

bool QgsVectorLayerProfileGenerator::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 658 of file qgsvectorlayerprofilegenerator.cpp.

◆ sourceId()

QString QgsVectorLayerProfileGenerator::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 651 of file qgsvectorlayerprofilegenerator.cpp.

◆ takeResults()

QgsAbstractProfileResults * QgsVectorLayerProfileGenerator::takeResults ( )
overridevirtual

Takes results from the generator.

Ownership is transferred to the caller.

Implements QgsAbstractProfileGenerator.

Definition at line 723 of file qgsvectorlayerprofilegenerator.cpp.

Friends And Related Function Documentation

◆ QgsVectorLayerProfileResults

friend class QgsVectorLayerProfileResults
friend

Definition at line 175 of file qgsvectorlayerprofilegenerator.h.


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