QGIS API Documentation  3.4.3-Madeira (2f64a3c)
Public Member Functions | List of all members
QgsMeshDatasetIndex Class Reference

QgsMeshDatasetIndex is index that identifies the dataset group (e.g. More...

#include <qgsmeshdataprovider.h>

Public Member Functions

 QgsMeshDatasetIndex (int group=-1, int dataset=-1)
 Creates an index. -1 represents invalid group/dataset. More...
 
int dataset () const
 Returns a dataset index within group() More...
 
int group () const
 Returns a group index. More...
 
bool isValid () const
 Returns whether index is valid, ie at least groups is set. More...
 
bool operator!= (const QgsMeshDatasetIndex &other) const
 Inequality operator. More...
 
bool operator== (const QgsMeshDatasetIndex &other) const
 Equality operator. More...
 

Detailed Description

QgsMeshDatasetIndex is index that identifies the dataset group (e.g.

wind speed) and a dataset in this group (e.g. magnitude of wind speed in particular time)

Note
The API is considered EXPERIMENTAL and can be changed without a notice
Since
QGIS 3.4

Definition at line 42 of file qgsmeshdataprovider.h.

Constructor & Destructor Documentation

◆ QgsMeshDatasetIndex()

QgsMeshDatasetIndex::QgsMeshDatasetIndex ( int  group = -1,
int  dataset = -1 
)

Creates an index. -1 represents invalid group/dataset.

Definition at line 24 of file qgsmeshdataprovider.cpp.

Member Function Documentation

◆ dataset()

int QgsMeshDatasetIndex::dataset ( ) const

Returns a dataset index within group()

Definition at line 33 of file qgsmeshdataprovider.cpp.

◆ group()

int QgsMeshDatasetIndex::group ( ) const

Returns a group index.

Definition at line 28 of file qgsmeshdataprovider.cpp.

◆ isValid()

bool QgsMeshDatasetIndex::isValid ( ) const

Returns whether index is valid, ie at least groups is set.

Definition at line 38 of file qgsmeshdataprovider.cpp.

◆ operator!=()

bool QgsMeshDatasetIndex::operator!= ( const QgsMeshDatasetIndex other) const

Inequality operator.

Definition at line 51 of file qgsmeshdataprovider.cpp.

◆ operator==()

bool QgsMeshDatasetIndex::operator== ( const QgsMeshDatasetIndex other) const

Equality operator.

Definition at line 43 of file qgsmeshdataprovider.cpp.


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