QGIS API Documentation  3.4.15-Madeira (e83d02e274)
Public Member Functions | List of all members
QgsMeshDatasetSourceInterface Class Referenceabstract

Interface for mesh datasets and dataset groups. More...

#include <qgsmeshdataprovider.h>

Inheritance diagram for QgsMeshDatasetSourceInterface:
Inheritance graph
[legend]

Public Member Functions

virtual ~QgsMeshDatasetSourceInterface ()=default
 Dtor. More...
 
virtual bool addDataset (const QString &uri)=0
 Associate dataset with the mesh. 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. 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...
 

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 289 of file qgsmeshdataprovider.h.

Constructor & Destructor Documentation

virtual QgsMeshDatasetSourceInterface::~QgsMeshDatasetSourceInterface ( )
virtualdefault

Dtor.

Member Function Documentation

virtual bool QgsMeshDatasetSourceInterface::addDataset ( const QString &  uri)
pure virtual

Associate dataset with the mesh.

emits dataChanged when successful

virtual int QgsMeshDatasetSourceInterface::datasetCount ( int  groupIndex) const
pure virtual

Returns number of datasets loaded in the group.

int QgsMeshDatasetSourceInterface::datasetCount ( QgsMeshDatasetIndex  index) const

Returns number of datasets loaded in the group.

Definition at line 186 of file qgsmeshdataprovider.cpp.

virtual int QgsMeshDatasetSourceInterface::datasetGroupCount ( ) const
pure virtual

Returns number of datasets groups loaded.

virtual QgsMeshDatasetGroupMetadata QgsMeshDatasetSourceInterface::datasetGroupMetadata ( int  groupIndex) const
pure virtual

Returns dataset group metadata.

QgsMeshDatasetGroupMetadata QgsMeshDatasetSourceInterface::datasetGroupMetadata ( QgsMeshDatasetIndex  index) const

Returns dataset group metadata.

Definition at line 191 of file qgsmeshdataprovider.cpp.

virtual QgsMeshDatasetMetadata QgsMeshDatasetSourceInterface::datasetMetadata ( QgsMeshDatasetIndex  index) const
pure virtual

Returns dataset metadata.

virtual QgsMeshDatasetValue QgsMeshDatasetSourceInterface::datasetValue ( QgsMeshDatasetIndex  index,
int  valueIndex 
) const
pure virtual

Returns vector/scalar value associated with the index from the dataset.

See QgsMeshDatasetMetadata::isVector() to check if the returned value is vector or scalar

virtual QStringList QgsMeshDatasetSourceInterface::extraDatasets ( ) const
pure virtual

Returns list of additional dataset file URIs added using addDataset() calls.

virtual bool QgsMeshDatasetSourceInterface::isFaceActive ( QgsMeshDatasetIndex  index,
int  faceIndex 
) const
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


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