QGIS API Documentation  3.11.0-Master (68611307d7)
Public Member Functions | List of all members
QgsMeshElevationAveragingMethod Class Reference

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

#include <qgsmesh3daveraging.h>

Inheritance diagram for QgsMeshElevationAveragingMethod:
Inheritance graph
[legend]

Public Member Functions

 QgsMeshElevationAveragingMethod ()
 Ctor. More...
 
 QgsMeshElevationAveragingMethod (double startElevation, double endElevation)
 Constructs elevation averaging method. More...
 
 ~QgsMeshElevationAveragingMethod () override
 
QgsMesh3dAveragingMethodclone () const override
 Clone the instance. More...
 
double endElevation () const
 Returns end elevation. 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 startElevation () const
 Returns start elevation. 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

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 361 of file qgsmesh3daveraging.h.

Constructor & Destructor Documentation

◆ QgsMeshElevationAveragingMethod() [1/2]

QgsMeshElevationAveragingMethod::QgsMeshElevationAveragingMethod ( )

Ctor.

Definition at line 549 of file qgsmesh3daveraging.cpp.

◆ QgsMeshElevationAveragingMethod() [2/2]

QgsMeshElevationAveragingMethod::QgsMeshElevationAveragingMethod ( double  startElevation,
double  endElevation 
)

Constructs elevation averaging method.

Parameters
startElevationstart elevation (absolute to model's datum)
endElevationend elevation (absolute to model's datum)

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

◆ endElevation()

double QgsMeshElevationAveragingMethod::endElevation ( ) const

Returns end elevation.

Definition at line 609 of file qgsmesh3daveraging.cpp.

◆ equals()

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

Returns whether method equals to other.

Implements QgsMesh3dAveragingMethod.

Definition at line 589 of file qgsmesh3daveraging.cpp.

◆ readXml()

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

Reads configuration from the given DOM element.

Implements QgsMesh3dAveragingMethod.

Definition at line 575 of file qgsmesh3daveraging.cpp.

◆ startElevation()

double QgsMeshElevationAveragingMethod::startElevation ( ) const

Returns start elevation.

Definition at line 604 of file qgsmesh3daveraging.cpp.

◆ writeXml()

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

Writes configuration to a new DOM element.

Implements QgsMesh3dAveragingMethod.

Definition at line 567 of file qgsmesh3daveraging.cpp.


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