QGIS API Documentation  3.14.0-Pi (9f7028fd23)
Public Member Functions | List of all members
QgsMeshDatasetIndex Class Reference

#include <qgsmeshdataset.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!= (QgsMeshDatasetIndex other) const
 Inequality operator. More...
bool operator== (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)

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

Definition at line 45 of file qgsmeshdataset.h.

Constructor & Destructor Documentation

◆ QgsMeshDatasetIndex()

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

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

Definition at line 22 of file qgsmeshdataset.cpp.

Member Function Documentation

◆ dataset()

int QgsMeshDatasetIndex::dataset ( ) const

Returns a dataset index within group()

Definition at line 31 of file qgsmeshdataset.cpp.

◆ group()

int QgsMeshDatasetIndex::group ( ) const

Returns a group index.

Definition at line 26 of file qgsmeshdataset.cpp.

◆ isValid()

bool QgsMeshDatasetIndex::isValid ( ) const

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

Definition at line 36 of file qgsmeshdataset.cpp.

◆ operator!=()

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

Inequality operator.

Definition at line 49 of file qgsmeshdataset.cpp.

◆ operator==()

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

Equality operator.

Definition at line 41 of file qgsmeshdataset.cpp.

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