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

Relative height averaging method averages the values based on range defined relative to bed elevation or surface (when countedFromTop()) The range is defined in the same length units as defined by model (e.g. More...

#include <qgsmesh3daveraging.h>

Inheritance diagram for QgsMeshRelativeHeightAveragingMethod:
Inheritance graph
[legend]

Public Member Functions

 QgsMeshRelativeHeightAveragingMethod ()
 Constructs default depth averaging method. More...
 
 QgsMeshRelativeHeightAveragingMethod (double startHeight, double endHeight, bool countedFromTop)
 Constructs the depth/height averaging method. More...
 
 ~QgsMeshRelativeHeightAveragingMethod () override
 
QgsMesh3dAveragingMethodclone () const override
 Clone the instance. More...
 
bool countedFromTop () const
 Returns whether the start and end vertical levels are relative to top (surface) or bottom (bed) level. More...
 
double endHeight () const
 Returns ending depth/height. More...
 
bool equals (const QgsMesh3dAveragingMethod *other) const override
 Returns whether method equals to other. More...
 
void readXml (const QDomElement &elem) override
 Reads configuration from the given DOM element. More...
 
double startHeight () const
 Returns starting depth/height. 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

Relative height averaging method averages the values based on range defined relative to bed elevation or surface (when countedFromTop()) The range is defined in the same length units as defined by model (e.g.

meters)

if countedFromTop(), the method represents averaging based on depth below surface. For example one can pull out results for between 6 to 12 meters below the water surface - depth from 6m to 12m. The depth will be truncated at the bed level.

if not countedFromTop(), the method represents averaging based on height above bed level. For example one can pull out results for between 6 to 12 meters above the bed - height from 6m to 12m. The height will be truncated at the bed level.

Since
QGIS 3.12

Definition at line 299 of file qgsmesh3daveraging.h.

Constructor & Destructor Documentation

◆ QgsMeshRelativeHeightAveragingMethod() [1/2]

QgsMeshRelativeHeightAveragingMethod::QgsMeshRelativeHeightAveragingMethod ( )

Constructs default depth averaging method.

Definition at line 452 of file qgsmesh3daveraging.cpp.

◆ QgsMeshRelativeHeightAveragingMethod() [2/2]

QgsMeshRelativeHeightAveragingMethod::QgsMeshRelativeHeightAveragingMethod ( double  startHeight,
double  endHeight,
bool  countedFromTop 
)

Constructs the depth/height averaging method.

Parameters
startHeightstarting depth/height, higher or equal than 0
endHeightending depth/height, higher or equal than startDepth
countedFromTopif true, the startLength and endLength is relative to surface (0 is surface level). if false, the startLength and endLength is relative to bed (0 is bed level).

Definition at line 457 of file qgsmesh3daveraging.cpp.

◆ ~QgsMeshRelativeHeightAveragingMethod()

QgsMeshRelativeHeightAveragingMethod::~QgsMeshRelativeHeightAveragingMethod ( )
overridedefault

Member Function Documentation

◆ clone()

QgsMesh3dAveragingMethod * QgsMeshRelativeHeightAveragingMethod::clone ( ) const
overridevirtual

Clone the instance.

Implements QgsMesh3dAveragingMethod.

Definition at line 505 of file qgsmesh3daveraging.cpp.

◆ countedFromTop()

bool QgsMeshRelativeHeightAveragingMethod::countedFromTop ( ) const

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

Definition at line 544 of file qgsmesh3daveraging.cpp.

◆ endHeight()

double QgsMeshRelativeHeightAveragingMethod::endHeight ( ) const

Returns ending depth/height.

Always higher or equal than startLength()

Definition at line 515 of file qgsmesh3daveraging.cpp.

◆ equals()

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

Returns whether method equals to other.

Implements QgsMesh3dAveragingMethod.

Definition at line 493 of file qgsmesh3daveraging.cpp.

◆ readXml()

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

Reads configuration from the given DOM element.

Implements QgsMesh3dAveragingMethod.

Definition at line 479 of file qgsmesh3daveraging.cpp.

◆ startHeight()

double QgsMeshRelativeHeightAveragingMethod::startHeight ( ) const

Returns starting depth/height.

Always lower or equal than endLength()

Definition at line 510 of file qgsmesh3daveraging.cpp.

◆ writeXml()

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

Writes configuration to a new DOM element.

Implements QgsMesh3dAveragingMethod.

Definition at line 471 of file qgsmesh3daveraging.cpp.


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