QgsAbstractProfileResults Class Reference

Abstract base class for storage of elevation profiles. More...

#include <qgsabstractprofilegenerator.h>

Inheritance diagram for QgsAbstractProfileResults:

Classes
struct	Feature
	Encapsulates information about a feature exported from the profile results. More...

Public Member Functions
virtual	~QgsAbstractProfileResults ()
virtual QVector< QgsAbstractProfileResults::Feature >	asFeatures (Qgis::ProfileExportType type, QgsFeedback *feedback=nullptr) const
	Returns a list of features representing the calculated elevation results.
virtual QVector< QgsGeometry >	asGeometries () const =0
	Returns a list of geometries representing the calculated elevation results.
virtual void	copyPropertiesFromGenerator (const QgsAbstractProfileGenerator *generator)
	Copies properties from specified generator to the results object.
virtual QMap< double, double >	distanceToHeightMap () const =0
	Returns the map of distance (chainage) to height.
virtual QVector< QgsProfileIdentifyResults >	identify (const QgsDoubleRange &distanceRange, const QgsDoubleRange &elevationRange, const QgsProfileIdentifyContext &context)
	Identify results visible within the specified ranges.
virtual QVector< QgsProfileIdentifyResults >	identify (const QgsProfilePoint &point, const QgsProfileIdentifyContext &context)
	Identify results visible at the specified profile point.
virtual void	renderResults (QgsProfileRenderContext &context)=0
	Renders the results to the specified context.
virtual QgsPointSequence	sampledPoints () const =0
	Returns a list of sampled points, with their calculated elevation as the point z value.
virtual QgsProfileSnapResult	snapPoint (const QgsProfilePoint &point, const QgsProfileSnapContext &context)
	Snaps a point to the generated elevation profile.
virtual QString	type () const =0
	Returns the unique string identifier for the results type.
virtual QgsDoubleRange	zRange () const =0
	Returns the range of the retrieved elevation values.

Detailed Description

Abstract base class for storage of elevation profiles.

Since

QGIS 3.26

Definition at line 192 of file qgsabstractprofilegenerator.h.

Constructor & Destructor Documentation

~QgsAbstractProfileResults()

QgsAbstractProfileResults::~QgsAbstractProfileResults ( )

virtualdefault

Member Function Documentation

asFeatures()

QVector< QgsAbstractProfileResults::Feature > QgsAbstractProfileResults::asFeatures ( Qgis::ProfileExportType  type, QgsFeedback *  feedback = nullptr  ) const

virtual

Returns a list of features representing the calculated elevation results.

The default implementation returns an empty list.

Since

QGIS 3.32

Reimplemented in QgsAbstractProfileSurfaceResults, QgsPointCloudLayerProfileResults, and QgsVectorLayerProfileResults.

Definition at line 62 of file qgsabstractprofilegenerator.cpp.

asGeometries()

virtual QVector< QgsGeometry > QgsAbstractProfileResults::asGeometries ( ) const

pure virtual

Returns a list of geometries representing the calculated elevation results.

Implemented in QgsAbstractProfileSurfaceResults, QgsPointCloudLayerProfileResults, and QgsVectorLayerProfileResults.

copyPropertiesFromGenerator()

void QgsAbstractProfileResults::copyPropertiesFromGenerator ( const QgsAbstractProfileGenerator *  generator )

virtual

Copies properties from specified generator to the results object.

For instance, this method can be used to copy any properties relating to rendering the gathered results to reflect the generator's current properties.

The base class method does nothing.

Reimplemented in QgsAbstractProfileSurfaceResults, QgsPointCloudLayerProfileResults, and QgsVectorLayerProfileResults.

Definition at line 82 of file qgsabstractprofilegenerator.cpp.

distanceToHeightMap()

virtual QMap< double, double > QgsAbstractProfileResults::distanceToHeightMap ( ) const

pure virtual

Returns the map of distance (chainage) to height.

Implemented in QgsAbstractProfileSurfaceResults, and QgsPointCloudLayerProfileResults.

identify() [1/2]

QVector< QgsProfileIdentifyResults > QgsAbstractProfileResults::identify ( const QgsDoubleRange &  distanceRange, const QgsDoubleRange &  elevationRange, const QgsProfileIdentifyContext &  context  )

virtual

Identify results visible within the specified ranges.

Reimplemented in QgsPointCloudLayerProfileResults, and QgsVectorLayerProfileResults.

Definition at line 77 of file qgsabstractprofilegenerator.cpp.

identify() [2/2]

QVector< QgsProfileIdentifyResults > QgsAbstractProfileResults::identify ( const QgsProfilePoint &  point, const QgsProfileIdentifyContext &  context  )

virtual

Identify results visible at the specified profile point.

Reimplemented in QgsAbstractProfileSurfaceResults, QgsMeshLayerProfileResults, QgsPointCloudLayerProfileResults, QgsRasterLayerProfileResults, and QgsVectorLayerProfileResults.

Definition at line 72 of file qgsabstractprofilegenerator.cpp.

renderResults()

virtual void QgsAbstractProfileResults::renderResults ( QgsProfileRenderContext &  context )

pure virtual

Renders the results to the specified context.

Implemented in QgsAbstractProfileSurfaceResults, QgsPointCloudLayerProfileResults, and QgsVectorLayerProfileResults.

sampledPoints()

virtual QgsPointSequence QgsAbstractProfileResults::sampledPoints ( ) const

pure virtual

Returns a list of sampled points, with their calculated elevation as the point z value.

Implemented in QgsAbstractProfileSurfaceResults, and QgsPointCloudLayerProfileResults.

snapPoint()

QgsProfileSnapResult QgsAbstractProfileResults::snapPoint ( const QgsProfilePoint &  point, const QgsProfileSnapContext &  context  )

virtual

Snaps a point to the generated elevation profile.

Reimplemented in QgsAbstractProfileSurfaceResults, QgsPointCloudLayerProfileResults, and QgsVectorLayerProfileResults.

Definition at line 67 of file qgsabstractprofilegenerator.cpp.

type()

virtual QString QgsAbstractProfileResults::type ( ) const

pure virtual

Returns the unique string identifier for the results type.

Implemented in QgsMeshLayerProfileResults, QgsPointCloudLayerProfileResults, QgsRasterLayerProfileResults, and QgsVectorLayerProfileResults.

zRange()

virtual QgsDoubleRange QgsAbstractProfileResults::zRange ( ) const

pure virtual

Returns the range of the retrieved elevation values.

Implemented in QgsAbstractProfileSurfaceResults, and QgsPointCloudLayerProfileResults.

---

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

• /build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/core/elevation/qgsabstractprofilegenerator.h
• /build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/core/elevation/qgsabstractprofilegenerator.cpp