QGIS API Documentation  3.11.0-Master (68611307d7)
Public Types | Public Member Functions | Static Public Member Functions | List of all members
QgsMesh3dAveragingMethod Class Referenceabstract

Abstract class to interpolate 3d stacked mesh data to 2d data. More...

#include <qgsmesh3daveraging.h>

Inheritance diagram for QgsMesh3dAveragingMethod:
Inheritance graph
[legend]

Public Types

enum  Method { MultiLevelsAveragingMethod = 0, SigmaAveragingMethod, RelativeHeightAveragingMethod, ElevationAveragingMethod }
 Type of averaging method. More...
 

Public Member Functions

 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 QgsMesh3dAveragingMethodclone () 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...
 

Static Public Member Functions

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

Abstract class to interpolate 3d stacked mesh data to 2d data.

Since
QGIS 3.12

Definition at line 39 of file qgsmesh3daveraging.h.

Member Enumeration Documentation

◆ Method

Type of averaging method.

Enumerator
MultiLevelsAveragingMethod 

Method to average values from selected vertical layers.

SigmaAveragingMethod 

Method to average values between 0 (bed level) and 1 (surface)

RelativeHeightAveragingMethod 

Method to average values defined by range of relative length units to the surface or bed level.

ElevationAveragingMethod 

Method to average values defined by range of absolute length units to the model's datum.

Definition at line 74 of file qgsmesh3daveraging.h.

Constructor & Destructor Documentation

◆ QgsMesh3dAveragingMethod()

QgsMesh3dAveragingMethod::QgsMesh3dAveragingMethod ( Method  method)

Ctor.

Definition at line 27 of file qgsmesh3daveraging.cpp.

◆ ~QgsMesh3dAveragingMethod()

virtual QgsMesh3dAveragingMethod::~QgsMesh3dAveragingMethod ( )
virtualdefault

Dtor.

Member Function Documentation

◆ calculate()

QgsMeshDataBlock QgsMesh3dAveragingMethod::calculate ( const QgsMesh3dDataBlock block3d,
QgsFeedback feedback = nullptr 
) const

Calculated 2d block values from 3d stacked mesh values.

Definition at line 57 of file qgsmesh3daveraging.cpp.

◆ clone()

virtual QgsMesh3dAveragingMethod* QgsMesh3dAveragingMethod::clone ( ) const
pure virtual

◆ createFromXml()

QgsMesh3dAveragingMethod * QgsMesh3dAveragingMethod::createFromXml ( const QDomElement &  elem)
static

Creates the instance from XML by calling readXml of derived classes.

Definition at line 32 of file qgsmesh3daveraging.cpp.

◆ equals() [1/2]

bool QgsMesh3dAveragingMethod::equals ( const QgsMesh3dAveragingMethod a,
const QgsMesh3dAveragingMethod b 
)
static

Returns whether two methods equal.

Definition at line 214 of file qgsmesh3daveraging.cpp.

◆ equals() [2/2]

virtual bool QgsMesh3dAveragingMethod::equals ( const QgsMesh3dAveragingMethod other) const
pure virtual

◆ method()

QgsMesh3dAveragingMethod::Method QgsMesh3dAveragingMethod::method ( ) const

Returns type of averaging method.

Definition at line 136 of file qgsmesh3daveraging.cpp.

◆ readXml()

virtual void QgsMesh3dAveragingMethod::readXml ( const QDomElement &  elem)
pure virtual

◆ writeXml()

virtual QDomElement QgsMesh3dAveragingMethod::writeXml ( QDomDocument &  doc) const
pure virtual

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