QGIS API Documentation  3.13.0-Master (7f54853aae)
Public Member Functions | List of all members
QgsMeshMultiLevelsAveragingMethod Class Reference

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

#include <qgsmesh3daveraging.h>

Inheritance diagram for QgsMeshMultiLevelsAveragingMethod:
Inheritance graph
[legend]

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
 
QgsMesh3dAveragingMethodclone () 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...
 
Method method () const
 Returns type of averaging method. 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 QgsMesh3dAveragingMethodcreateFromXml (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 158 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 234 of file qgsmesh3daveraging.cpp.

◆ QgsMeshMultiLevelsAveragingMethod() [2/3]

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

Constructs multi level averaging method.

Parameters
startLevelstarting vertical level index numbered from 1
endLevelending vertical level index numbered from 1 (higher or equal than startLevel)
countedFromTopif 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 222 of file qgsmesh3daveraging.cpp.

◆ QgsMeshMultiLevelsAveragingMethod() [3/3]

QgsMeshMultiLevelsAveragingMethod::QgsMeshMultiLevelsAveragingMethod ( int  verticalLevel,
bool  countedFromTop 
)

Constructs single level averaging method.

Parameters
verticalLevelvertical level index numbered from 1
countedFromTopif 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 239 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 283 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 441 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 294 of file qgsmesh3daveraging.cpp.

◆ equals()

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

Returns whether method equals to other.

Implements QgsMesh3dAveragingMethod.

Definition at line 271 of file qgsmesh3daveraging.cpp.

◆ isSingleLevel()

bool QgsMeshMultiLevelsAveragingMethod::isSingleLevel ( ) const

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

Definition at line 446 of file qgsmesh3daveraging.cpp.

◆ readXml()

void QgsMeshMultiLevelsAveragingMethod::readXml ( const QDomElement &  elem)
overridevirtual

Reads configuration from the given DOM element.

Implements QgsMesh3dAveragingMethod.

Definition at line 257 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 289 of file qgsmesh3daveraging.cpp.

◆ writeXml()

QDomElement QgsMeshMultiLevelsAveragingMethod::writeXml ( QDomDocument &  doc) const
overridevirtual

Writes configuration to a new DOM element.

Implements QgsMesh3dAveragingMethod.

Definition at line 249 of file qgsmesh3daveraging.cpp.


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