QgsMeshElevationAveragingMethod Class Reference

Elevation averaging method averages the values based on range defined absolute value to the model's datum. More...

#include <qgsmesh3daveraging.h>

Inheritance diagram for QgsMeshElevationAveragingMethod:

Public Member Functions
	QgsMeshElevationAveragingMethod ()
	QgsMeshElevationAveragingMethod (double startElevation, double endElevation)
	Constructs elevation averaging method.
	~QgsMeshElevationAveragingMethod () override
QgsMesh3DAveragingMethod *	clone () const override
	Clone the instance.
double	endElevation () const
	Returns end elevation.
bool	equals (const QgsMesh3DAveragingMethod *other) const override
	Returns whether method equals to other.
void	readXml (const QDomElement &elem) override
	Reads configuration from the given DOM element.
double	startElevation () const
	Returns start elevation.
QDomElement	writeXml (QDomDocument &doc) const override
	Writes configuration to a new DOM element.
Public Member Functions inherited from QgsMesh3DAveragingMethod
	QgsMesh3DAveragingMethod (Method method)
	Ctor.
virtual	~QgsMesh3DAveragingMethod ()=default
QgsMeshDataBlock	calculate (const QgsMesh3DDataBlock &block3d, QgsFeedback *feedback=nullptr) const
	Calculated 2d block values from 3d stacked mesh values.
Method	method () const
	Returns type of averaging method.

Additional Inherited Members
Public Types inherited from QgsMesh3DAveragingMethod
enum	Method { MultiLevelsAveragingMethod = 0 , SigmaAveragingMethod , RelativeHeightAveragingMethod , ElevationAveragingMethod }
	Type of averaging method. More...
Static Public Member Functions inherited from QgsMesh3DAveragingMethod
static QgsMesh3DAveragingMethod *	createFromXml (const QDomElement &elem)
	Creates the instance from XML by calling readXml of derived classes.
static bool	equals (const QgsMesh3DAveragingMethod *a, const QgsMesh3DAveragingMethod *b)
	Returns whether two methods equal.

Detailed Description

Elevation averaging method averages the values based on range defined absolute value to the model's datum.

The range is defined in the same length units as defined by model (e.g. meters)

For example one can pull out results irrespective of water level change such as between -16m and -10m. The elevation will be truncated at the surface and bed levels.

Since

QGIS 3.12

Definition at line 368 of file qgsmesh3daveraging.h.

Constructor & Destructor Documentation

QgsMeshElevationAveragingMethod() [1/2]

QgsMeshElevationAveragingMethod::QgsMeshElevationAveragingMethod

(

)

Definition at line 579 of file qgsmesh3daveraging.cpp.

QgsMeshElevationAveragingMethod() [2/2]

QgsMeshElevationAveragingMethod::QgsMeshElevationAveragingMethod	(	double	startElevation,
		double	endElevation
	)

Constructs elevation averaging method.

Parameters

startElevation	start elevation (absolute to model's datum)
endElevation	end elevation (absolute to model's datum)

Definition at line 584 of file qgsmesh3daveraging.cpp.

~QgsMeshElevationAveragingMethod()

QgsMeshElevationAveragingMethod::~QgsMeshElevationAveragingMethod ( )

overridedefault

Member Function Documentation

clone()

QgsMesh3DAveragingMethod * QgsMeshElevationAveragingMethod::clone ( ) const

overridevirtual

Clone the instance.

Implements QgsMesh3DAveragingMethod.

Definition at line 629 of file qgsmesh3daveraging.cpp.

endElevation()

double QgsMeshElevationAveragingMethod::endElevation

(

)

const

Returns end elevation.

Definition at line 639 of file qgsmesh3daveraging.cpp.

equals()

bool QgsMeshElevationAveragingMethod::equals ( const QgsMesh3DAveragingMethod *  other ) const

overridevirtual

Returns whether method equals to other.

Implements QgsMesh3DAveragingMethod.

Definition at line 619 of file qgsmesh3daveraging.cpp.

readXml()

void QgsMeshElevationAveragingMethod::readXml ( const QDomElement &  elem )

overridevirtual

Reads configuration from the given DOM element.

Implements QgsMesh3DAveragingMethod.

Definition at line 605 of file qgsmesh3daveraging.cpp.

startElevation()

double QgsMeshElevationAveragingMethod::startElevation

(

)

const

Returns start elevation.

Definition at line 634 of file qgsmesh3daveraging.cpp.

writeXml()

QDomElement QgsMeshElevationAveragingMethod::writeXml ( QDomDocument &  doc ) const

overridevirtual

Writes configuration to a new DOM element.

Implements QgsMesh3DAveragingMethod.

Definition at line 597 of file qgsmesh3daveraging.cpp.

---

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

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