Multi level averaging method specifies limits of vertical layers from the top layer down or reversed. More...

#include <qgsmesh3daveraging.h>

Inheritance diagram for QgsMeshMultiLevelsAveragingMethod:

Public Member Functions
	QgsMeshMultiLevelsAveragingMethod ()
	Constructs single level averaging method for 1st (top) vertical level. More...

	QgsMeshMultiLevelsAveragingMethod (int startLevel, int endLevel, bool countedFromTop)
	Constructs multi level averaging method. More...

	QgsMeshMultiLevelsAveragingMethod (int verticalLevel, bool countedFromTop)
	Constructs single level averaging method. More...

	~QgsMeshMultiLevelsAveragingMethod () override

QgsMesh3dAveragingMethod *	clone () const override
	Clone the instance. More...

bool	countedFromTop () const
	Returns whether the start and end vertical levels are indexed from top (surface) or bottom (bed) level. More...

int	endVerticalLevel () const
	Returns ending vertical level. More...

bool	equals (const QgsMesh3dAveragingMethod *other) const override
	Returns whether method equals to other. More...

bool	isSingleLevel () const
	Returns whether the averaging method selects only a single vertical level. More...

void	readXml (const QDomElement &elem) override
	Reads configuration from the given DOM element. More...

int	startVerticalLevel () const
	Returns starting vertical level. More...

QDomElement	writeXml (QDomDocument &doc) const override
	Writes configuration to a new DOM element. More...

Public Member Functions inherited from QgsMesh3dAveragingMethod
	QgsMesh3dAveragingMethod (Method method)
	Ctor. More...

virtual	~QgsMesh3dAveragingMethod ()=default
	Dtor. More...

QgsMeshDataBlock	calculate (const QgsMesh3dDataBlock &block3d, QgsFeedback *feedback=nullptr) const
	Calculated 2d block values from 3d stacked mesh values. More...

virtual QgsMesh3dAveragingMethod *	clone () const =0
	Clone the instance. More...

virtual bool	equals (const QgsMesh3dAveragingMethod *other) const =0
	Returns whether method equals to other. More...

Method	method () const
	Returns type of averaging method. More...

virtual void	readXml (const QDomElement &elem)=0
	Reads configuration from the given DOM element. More...

virtual QDomElement	writeXml (QDomDocument &doc) const =0
	Writes configuration to a new DOM element. More...

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. More...

static bool	equals (const QgsMesh3dAveragingMethod a, const QgsMesh3dAveragingMethod b)
	Returns whether two methods equal. More...

Detailed Description

Multi level averaging method specifies limits of vertical layers from the top layer down or reversed.

The limits will be truncated to the maximum number of vertical layers. To pick value from a single layer, specify the upper and lower limit to be the same

Since: QGIS 3.12

Definition at line 159 of file qgsmesh3daveraging.h.

Constructor & Destructor Documentation

◆ QgsMeshMultiLevelsAveragingMethod() [1/3]

QgsMeshMultiLevelsAveragingMethod::QgsMeshMultiLevelsAveragingMethod ( )

Constructs single level averaging method for 1st (top) vertical level.

Definition at line 250 of file qgsmesh3daveraging.cpp.

◆ QgsMeshMultiLevelsAveragingMethod() [2/3]

QgsMeshMultiLevelsAveragingMethod::QgsMeshMultiLevelsAveragingMethod	(	int	startLevel,
		int	endLevel,
		bool	countedFromTop
	)

Constructs multi level averaging method.

Parameters

startLevel	starting vertical level index numbered from 1
endLevel	ending vertical level index numbered from 1 (higher or equal than startLevel)
countedFromTop	if `true`, the startLevel index is counted from surface (index 1 is the top layer). if `false`, the startLevel index is counted from the bed level (index 1 is the bottom layer)

Definition at line 238 of file qgsmesh3daveraging.cpp.

◆ QgsMeshMultiLevelsAveragingMethod() [3/3]

QgsMeshMultiLevelsAveragingMethod::QgsMeshMultiLevelsAveragingMethod	(	int	verticalLevel,
		bool	countedFromTop
	)

Constructs single level averaging method.

Parameters

verticalLevel	vertical level index numbered from 1
countedFromTop	if `true`, the startLevel index is counted from surface (index 1 is the top layer). if `false`, the startLevel index is counted from the bed level (index 1 is the bottom layer)

Definition at line 255 of file qgsmesh3daveraging.cpp.

◆ ~QgsMeshMultiLevelsAveragingMethod()

QgsMeshMultiLevelsAveragingMethod::~QgsMeshMultiLevelsAveragingMethod ( )

overridedefault

Member Function Documentation

◆ clone()

QgsMesh3dAveragingMethod * QgsMeshMultiLevelsAveragingMethod::clone ( ) const

overridevirtual

Clone the instance.

Implements QgsMesh3dAveragingMethod.

Definition at line 299 of file qgsmesh3daveraging.cpp.

◆ countedFromTop()

bool QgsMeshMultiLevelsAveragingMethod::countedFromTop ( ) const

Returns whether the start and end vertical levels are indexed from top (surface) or bottom (bed) level.

Definition at line 471 of file qgsmesh3daveraging.cpp.

◆ endVerticalLevel()

int QgsMeshMultiLevelsAveragingMethod::endVerticalLevel ( ) const

Returns ending vertical level.

Numbered from 1. If countedFromTop(), 1 represents the top (surface) level, otherwise 1 represents the bottom (bed) level

Always lower or equal than endVerticalLevel()

Definition at line 310 of file qgsmesh3daveraging.cpp.

◆ equals()

bool QgsMeshMultiLevelsAveragingMethod::equals ( const QgsMesh3dAveragingMethod * other ) const

overridevirtual

Returns whether method equals to other.

Implements QgsMesh3dAveragingMethod.

Definition at line 287 of file qgsmesh3daveraging.cpp.

◆ isSingleLevel()

bool QgsMeshMultiLevelsAveragingMethod::isSingleLevel ( ) const

Returns whether the averaging method selects only a single vertical level.

Definition at line 476 of file qgsmesh3daveraging.cpp.

◆ readXml()

void QgsMeshMultiLevelsAveragingMethod::readXml ( const QDomElement & elem )

overridevirtual

Reads configuration from the given DOM element.

Implements QgsMesh3dAveragingMethod.

Definition at line 273 of file qgsmesh3daveraging.cpp.

◆ startVerticalLevel()

int QgsMeshMultiLevelsAveragingMethod::startVerticalLevel ( ) const

Returns starting vertical level.

Numbered from 1. If countedFromTop(), 1 represents the top (surface) level, otherwise 1 represents the bottom (bed) level

Always lower or equal than endVerticalLevel()

Definition at line 305 of file qgsmesh3daveraging.cpp.

◆ writeXml()

QDomElement QgsMeshMultiLevelsAveragingMethod::writeXml ( QDomDocument & doc ) const

overridevirtual

Writes configuration to a new DOM element.

Implements QgsMesh3dAveragingMethod.

Definition at line 265 of file qgsmesh3daveraging.cpp.

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

/build/qgis-3.30.0+99sid/src/core/mesh/qgsmesh3daveraging.h
/build/qgis-3.30.0+99sid/src/core/mesh/qgsmesh3daveraging.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsMeshMultiLevelsAveragingMethod() [1/3]

◆ QgsMeshMultiLevelsAveragingMethod() [2/3]

◆ QgsMeshMultiLevelsAveragingMethod() [3/3]

◆ ~QgsMeshMultiLevelsAveragingMethod()

Member Function Documentation

◆ clone()

◆ countedFromTop()

◆ endVerticalLevel()

◆ equals()

◆ isSingleLevel()

◆ readXml()

◆ startVerticalLevel()

◆ writeXml()