QGIS API Documentation  3.2.0-Bonn (bc43194)
Public Member Functions | List of all members
QgsMeshDatasetSourceInterface Class Referenceabstract

Interface for mesh datasets. More...

#include <qgsmeshdataprovider.h>

Inheritance diagram for QgsMeshDatasetSourceInterface:
Inheritance graph

Public Member Functions

virtual ~QgsMeshDatasetSourceInterface ()=default
 Dtor. More...
virtual bool addDataset (const QString &uri)=0
 Associate dataset with the mesh. More...
virtual int datasetCount () const =0
 Returns number of datasets loaded. More...
virtual QgsMeshDatasetMetadata datasetMetadata (int datasetIndex) const =0
 Returns dataset metadata. More...
virtual QgsMeshDatasetValue datasetValue (int datasetIndex, int valueIndex) const =0
 Returns vector/scalar value associated with the index from the dataset. More...

Detailed Description

Interface for mesh datasets.

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

The API is considered EXPERIMENTAL and can be changed without a notice
QGIS 3.2

Definition at line 210 of file qgsmeshdataprovider.h.

Constructor & Destructor Documentation

◆ ~QgsMeshDatasetSourceInterface()

virtual QgsMeshDatasetSourceInterface::~QgsMeshDatasetSourceInterface ( )


Member Function Documentation

◆ addDataset()

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

Associate dataset with the mesh.

◆ datasetCount()

virtual int QgsMeshDatasetSourceInterface::datasetCount ( ) const
pure virtual

Returns number of datasets loaded.

◆ datasetMetadata()

virtual QgsMeshDatasetMetadata QgsMeshDatasetSourceInterface::datasetMetadata ( int  datasetIndex) const
pure virtual

Returns dataset metadata.

◆ datasetValue()

virtual QgsMeshDatasetValue QgsMeshDatasetSourceInterface::datasetValue ( int  datasetIndex,
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

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