Convenient class that can be used to obtain a datasetgroup on vertices that represents the Z value of the mesh vertices. More...
#include <qgsmeshtriangulation.h>
Public Member Functions | |
| QgsMeshZValueDatasetGroup (const QString &datasetGroupName, const QgsMesh &mesh) | |
| Constructor. More... | |
| QgsMeshDataset * | dataset (int index) const override |
| Returns the dataset with index. More... | |
| int | datasetCount () const override |
| Returns the count of datasets in the group. More... | |
| QgsMeshDatasetMetadata | datasetMetadata (int datasetIndex) const override |
| Returns the metadata of the dataset with index datasetIndex. More... | |
| void | initialize () override |
| Initialize the dataset group. More... | |
| QgsMeshDatasetGroup::Type | type () const override |
| Returns the type of dataset group. More... | |
| QDomElement | writeXml (QDomDocument &doc, const QgsReadWriteContext &context) const override |
| Write dataset group information in a DOM element. More... | |
 Public Member Functions inherited from QgsMeshDatasetGroup | |
| QgsMeshDatasetGroup ()=default | |
| Default constructor. More... | |
| QgsMeshDatasetGroup (const QString &name) | |
| Constructor with the name of the dataset group. More... | |
| QgsMeshDatasetGroup (const QString &name, QgsMeshDatasetGroupMetadata::DataType dataType) | |
| Constructor with the name of the dataset group and the dataTYpe. More... | |
| virtual | ~QgsMeshDatasetGroup () |
| void | addExtraMetadata (QString key, QString value) |
| Adds extra metadata to the group. More... | |
| void | calculateStatistic () |
| Calculates the statistics (minimum and maximum) More... | |
| bool | checkValueCountPerDataset (int count) const |
| Returns whether all the datasets contain count values. More... | |
| virtual QStringList | datasetGroupNamesDependentOn () const |
| Returns the dataset group variable name which this dataset group depends on. More... | |
| QgsMeshDatasetGroupMetadata::DataType | dataType () const |
| Returns the data type of the dataset group. More... | |
| virtual QString | description () const |
| Returns some information about the dataset group. More... | |
| QMap< QString, QString > | extraMetadata () const |
| Returns all the extra metadata of the group. More... | |
| QgsMeshDatasetGroupMetadata | groupMetadata () const |
| Returns the metadata of the dataset group. More... | |
| bool | isScalar () const |
| Returns whether the group contain scalar values. More... | |
| double | maximum () const |
| Returns the maximum value of the whole dataset group. More... | |
| double | minimum () const |
| Returns the minimum value of the whole dataset group. More... | |
| QString | name () const |
| Returns the name of the dataset group. More... | |
| void | setDataType (const QgsMeshDatasetGroupMetadata::DataType &dataType) |
| Sets the data type of the dataset group. More... | |
| void | setIsScalar (bool isScalar) |
| Sets whether the group contain scalar values. More... | |
| void | setMinimumMaximum (double min, double max) |
| Overrides the minimum and the maximum value of the whole dataset group. More... | |
| void | setName (const QString &name) |
| Sets the name of the dataset group. More... | |
| void | setReferenceTime (const QDateTime &referenceTime) |
| Sets the reference time of the dataset group. More... | |
Additional Inherited Members | |
| Public Types inherited from QgsMeshDatasetGroup | |
| enum | Type { None , Persistent , Memory , Virtual } |
| Type of the dataset group. More... | |
| Protected Attributes inherited from QgsMeshDatasetGroup | |
| QgsMeshDatasetGroupMetadata::DataType | mDataType = QgsMeshDatasetGroupMetadata::DataOnVertices |
| bool | mIsScalar = true |
| QMap< QString, QString > | mMetadata |
| QString | mName |
Detailed Description
Convenient class that can be used to obtain a datasetgroup on vertices that represents the Z value of the mesh vertices.
- Since
- QGIS 3.16
Definition at line 133 of file qgsmeshtriangulation.h.
Constructor & Destructor Documentation
◆ QgsMeshZValueDatasetGroup()
| QgsMeshZValueDatasetGroup::QgsMeshZValueDatasetGroup | ( | const QString & | datasetGroupName, |
| const QgsMesh & | mesh | ||
| ) |
Constructor.
- Parameters
-
datasetGroupName the name of the dataset group mesh the mesh used to create the Z value dataset
Definition at line 242 of file qgsmeshtriangulation.cpp.
Member Function Documentation
◆ dataset()
|
overridevirtual |
Returns the dataset with index.
Implements QgsMeshDatasetGroup.
Definition at line 263 of file qgsmeshtriangulation.cpp.
◆ datasetCount()
|
overridevirtual |
Returns the count of datasets in the group.
Implements QgsMeshDatasetGroup.
Definition at line 261 of file qgsmeshtriangulation.cpp.
◆ datasetMetadata()
|
overridevirtual |
Returns the metadata of the dataset with index datasetIndex.
Implements QgsMeshDatasetGroup.
Definition at line 253 of file qgsmeshtriangulation.cpp.
◆ initialize()
|
overridevirtual |
Initialize the dataset group.
Implements QgsMeshDatasetGroup.
Definition at line 248 of file qgsmeshtriangulation.cpp.
◆ type()
|
inlineoverridevirtual |
Returns the type of dataset group.
Implements QgsMeshDatasetGroup.
Definition at line 149 of file qgsmeshtriangulation.h.
◆ writeXml()
|
overridevirtual |
Write dataset group information in a DOM element.
Implements QgsMeshDatasetGroup.
Definition at line 271 of file qgsmeshtriangulation.cpp.
The documentation for this class was generated from the following files:
- /build/qgis-3.20.0+99unstable/src/analysis/mesh/qgsmeshtriangulation.h
- /build/qgis-3.20.0+99unstable/src/analysis/mesh/qgsmeshtriangulation.cpp
