Interface for classes which can generate elevation profiles. More...

#include <qgsabstractprofilesource.h>

Inheritance diagram for QgsAbstractProfileSource:

[legend]

Public Member Functions
virtual	~QgsAbstractProfileSource ()
virtual QgsAbstractProfileGenerator *	createProfileGenerator (const QgsProfileRequest &request)=0
	Given a profile request, returns a new profile generator ready for generating elevation profiles.
virtual QString	profileSourceId () const
	Returns a unique identifier for this profile source.
virtual QString	profileSourceName () const
	Returns a name for displaying this profile source in the elevation profile layer tree.

Detailed Description

Interface for classes which can generate elevation profiles.

Since: QGIS 3.26

Definition at line 34 of file qgsabstractprofilesource.h.

Constructor & Destructor Documentation

◆ ~QgsAbstractProfileSource()

QgsAbstractProfileSource::~QgsAbstractProfileSource ( )

virtualdefault

Member Function Documentation

◆ createProfileGenerator()

virtual QgsAbstractProfileGenerator * QgsAbstractProfileSource::createProfileGenerator ( const QgsProfileRequest & request )

pure virtual

Given a profile request, returns a new profile generator ready for generating elevation profiles.

The caller takes ownership of the returned generator.

May return nullptr if the source cannot generate a profile at this time.

Implemented in QgsMeshLayer, QgsPointCloudLayer, QgsRasterLayer, and QgsVectorLayer.

◆ profileSourceId()

virtual QString QgsAbstractProfileSource::profileSourceId ( ) const

inlinevirtual

Returns a unique identifier for this profile source.

For map layer sources, 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.

Since: QGIS 4.0.0

Reimplemented in QgsMeshLayer, QgsPointCloudLayer, QgsRasterLayer, and QgsVectorLayer.

Definition at line 59 of file qgsabstractprofilesource.h.

◆ profileSourceName()

virtual QString QgsAbstractProfileSource::profileSourceName ( ) const

inlinevirtual

Returns a name for displaying this profile source in the elevation profile layer tree.

For map layer sources, the name displayed in the elevation profile tree will be taken from and synchronized to the layer's name.

Since: QGIS 4.0.0