Interface for mesh datasets and dataset groups. More...
#include <qgsmeshdataprovider.h>
Public Member Functions | |
| virtual | ~QgsMeshDatasetSourceInterface ()=default |
| Dtor. More... | |
| virtual bool | addDataset (const QString &uri)=0 |
| Associate dataset with the mesh. More... | |
| virtual QgsMeshDataBlock | areFacesActive (QgsMeshDatasetIndex index, int faceIndex, int count) const =0 |
| Returns whether the faces are active for particular dataset. More... | |
| virtual int | datasetCount (int groupIndex) const =0 |
| Returns number of datasets loaded in the group. More... | |
| int | datasetCount (QgsMeshDatasetIndex index) const |
| Returns number of datasets loaded in the group. More... | |
| virtual int | datasetGroupCount () const =0 |
| Returns number of datasets groups loaded. More... | |
| virtual QgsMeshDatasetGroupMetadata | datasetGroupMetadata (int groupIndex) const =0 |
| Returns dataset group metadata. More... | |
| QgsMeshDatasetGroupMetadata | datasetGroupMetadata (QgsMeshDatasetIndex index) const |
| Returns dataset group metadata. More... | |
| virtual QgsMeshDatasetMetadata | datasetMetadata (QgsMeshDatasetIndex index) const =0 |
| Returns dataset metadata. More... | |
| virtual QgsMeshDatasetValue | datasetValue (QgsMeshDatasetIndex index, int valueIndex) const =0 |
| Returns vector/scalar value associated with the index from the dataset To read multiple continuous values, use QgsMeshDatasetSourceInterface::datasetValues() More... | |
| virtual QgsMeshDataBlock | datasetValues (QgsMeshDatasetIndex index, int valueIndex, int count) const =0 |
| Returns N vector/scalar values from the index from the dataset. More... | |
| virtual QStringList | extraDatasets () const =0 |
| Returns list of additional dataset file URIs added using addDataset() calls. More... | |
| virtual bool | isFaceActive (QgsMeshDatasetIndex index, int faceIndex) const =0 |
| Returns whether the face is active for particular dataset. More... | |
| virtual bool | persistDatasetGroup (const QString &path, const QgsMeshDatasetGroupMetadata &meta, const QVector< QgsMeshDataBlock > &datasetValues, const QVector< QgsMeshDataBlock > &datasetActive, const QVector< double > ×)=0 |
| Creates a new dataset group from a data and persists it into a destination path. More... | |
Detailed Description
Interface for mesh datasets and dataset groups.
Dataset is a collection of vector or scalar values on vertices or faces of the mesh. Based on the underlying data provider/format, whole dataset is either stored in memory or read on demand
Datasets are grouped in the dataset groups. A dataset group represents a measured quantity (e.g. depth or wind speed), dataset represents values of the quantity in a particular time.
- Note
- The API is considered EXPERIMENTAL and can be changed without a notice
- Since
- QGIS 3.2
Definition at line 428 of file qgsmeshdataprovider.h.
Constructor & Destructor Documentation
◆ ~QgsMeshDatasetSourceInterface()
|
virtualdefault |
Dtor.
Member Function Documentation
◆ addDataset()
|
pure virtual |
Associate dataset with the mesh.
emits dataChanged when successful
◆ areFacesActive()
|
pure virtual |
Returns whether the faces are active for particular dataset.
- Since
- QGIS 3.6
◆ datasetCount() [1/2]
|
pure virtual |
Returns number of datasets loaded in the group.
◆ datasetCount() [2/2]
| int QgsMeshDatasetSourceInterface::datasetCount | ( | QgsMeshDatasetIndex | index | ) | const |
Returns number of datasets loaded in the group.
Definition at line 180 of file qgsmeshdataprovider.cpp.
◆ datasetGroupCount()
|
pure virtual |
Returns number of datasets groups loaded.
◆ datasetGroupMetadata() [1/2]
|
pure virtual |
Returns dataset group metadata.
◆ datasetGroupMetadata() [2/2]
| QgsMeshDatasetGroupMetadata QgsMeshDatasetSourceInterface::datasetGroupMetadata | ( | QgsMeshDatasetIndex | index | ) | const |
Returns dataset group metadata.
Definition at line 185 of file qgsmeshdataprovider.cpp.
◆ datasetMetadata()
|
pure virtual |
Returns dataset metadata.
◆ datasetValue()
|
pure virtual |
Returns vector/scalar value associated with the index from the dataset To read multiple continuous values, use QgsMeshDatasetSourceInterface::datasetValues()
See QgsMeshDatasetMetadata::isVector() or QgsMeshDataBlock::type() to check if the returned value is vector or scalar
◆ datasetValues()
|
pure virtual |
Returns N vector/scalar values from the index from the dataset.
See QgsMeshDatasetMetadata::isVector() to check if the returned value is vector or scalar
- Since
- QGIS 3.6
◆ extraDatasets()
|
pure virtual |
Returns list of additional dataset file URIs added using addDataset() calls.
◆ isFaceActive()
|
pure virtual |
Returns whether the face is active for particular dataset.
For example to represent the situation when F1 and F3 are flooded, but F2 is dry, some solvers store water depth on vertices V1-V8 (all non-zero values) and set active flag for F2 to false. V1 -— V2 -— V5--—V7 | F1 | F2 | F3 | V3 -— V4 -— V6--—V8
◆ persistDatasetGroup()
|
pure virtual |
Creates a new dataset group from a data and persists it into a destination path.
On success, the mesh's dataset group count is changed
- Parameters
-
path destination path of the stored file meta new group's metadata datasetValues scalar/vector values for all datasets and all faces/vertices in the group datasetActive active flag values for all datasets in the group. Empty array represents can be used when all faces are active times times in hours for all datasets in the group
- Returns
- true on failure, false on success
- Since
- QGIS 3.6
The documentation for this class was generated from the following files:
- /tmp/buildd/qgis-3.6.0+99unstable/src/core/mesh/qgsmeshdataprovider.h
- /tmp/buildd/qgis-3.6.0+99unstable/src/core/mesh/qgsmeshdataprovider.cpp
