QGIS API Documentation 3.34.0-Prizren (ffbdd678812)
|
Multi level averaging method specifies limits of vertical layers from the top layer down or reversed. More...
#include <qgsmesh3daveraging.h>
Public Member Functions | |
QgsMeshMultiLevelsAveragingMethod () | |
Constructs single level averaging method for 1st (top) vertical level. | |
QgsMeshMultiLevelsAveragingMethod (int startLevel, int endLevel, bool countedFromTop) | |
Constructs multi level averaging method. | |
QgsMeshMultiLevelsAveragingMethod (int verticalLevel, bool countedFromTop) | |
Constructs single level averaging method. | |
~QgsMeshMultiLevelsAveragingMethod () override | |
QgsMesh3DAveragingMethod * | clone () const override |
Clone the instance. | |
bool | countedFromTop () const |
Returns whether the start and end vertical levels are indexed from top (surface) or bottom (bed) level. | |
int | endVerticalLevel () const |
Returns ending vertical level. | |
bool | equals (const QgsMesh3DAveragingMethod *other) const override |
Returns whether method equals to other. | |
bool | isSingleLevel () const |
Returns whether the averaging method selects only a single vertical level. | |
void | readXml (const QDomElement &elem) override |
Reads configuration from the given DOM element. | |
int | startVerticalLevel () const |
Returns starting vertical level. | |
QDomElement | writeXml (QDomDocument &doc) const override |
Writes configuration to a new DOM element. | |
Public Member Functions inherited from QgsMesh3DAveragingMethod | |
QgsMesh3DAveragingMethod (Method method) | |
Ctor. | |
virtual | ~QgsMesh3DAveragingMethod ()=default |
Dtor. | |
QgsMeshDataBlock | calculate (const QgsMesh3DDataBlock &block3d, QgsFeedback *feedback=nullptr) const |
Calculated 2d block values from 3d stacked mesh values. | |
Method | method () const |
Returns type of averaging method. | |
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. | |
static bool | equals (const QgsMesh3DAveragingMethod *a, const QgsMesh3DAveragingMethod *b) |
Returns whether two methods equal. | |
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
Definition at line 161 of file qgsmesh3daveraging.h.
QgsMeshMultiLevelsAveragingMethod::QgsMeshMultiLevelsAveragingMethod | ( | ) |
Constructs single level averaging method for 1st (top) vertical level.
Definition at line 250 of file qgsmesh3daveraging.cpp.
QgsMeshMultiLevelsAveragingMethod::QgsMeshMultiLevelsAveragingMethod | ( | int | startLevel, |
int | endLevel, | ||
bool | countedFromTop | ||
) |
Constructs multi level averaging method.
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::QgsMeshMultiLevelsAveragingMethod | ( | int | verticalLevel, |
bool | countedFromTop | ||
) |
Constructs single level averaging method.
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.
|
overridedefault |
|
overridevirtual |
Clone the instance.
Implements QgsMesh3DAveragingMethod.
Definition at line 299 of file qgsmesh3daveraging.cpp.
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.
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.
|
overridevirtual |
Returns whether method equals to other.
Implements QgsMesh3DAveragingMethod.
Definition at line 287 of file qgsmesh3daveraging.cpp.
bool QgsMeshMultiLevelsAveragingMethod::isSingleLevel | ( | ) | const |
Returns whether the averaging method selects only a single vertical level.
Definition at line 476 of file qgsmesh3daveraging.cpp.
|
overridevirtual |
Reads configuration from the given DOM element.
Implements QgsMesh3DAveragingMethod.
Definition at line 273 of file qgsmesh3daveraging.cpp.
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.
|
overridevirtual |
Writes configuration to a new DOM element.
Implements QgsMesh3DAveragingMethod.
Definition at line 265 of file qgsmesh3daveraging.cpp.