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) More...

#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)

Note: The API is considered EXPERIMENTAL and can be changed without a notice

Since: QGIS 3.4

Definition at line 48 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 23 of file qgsmeshdataset.cpp.

Member Function Documentation

◆ dataset()

int QgsMeshDatasetIndex::dataset ( ) const

Returns a dataset index within group()

Definition at line 32 of file qgsmeshdataset.cpp.

◆ group()

int QgsMeshDatasetIndex::group ( ) const

Returns a group index.

Definition at line 27 of file qgsmeshdataset.cpp.

◆ isValid()

bool QgsMeshDatasetIndex::isValid ( ) const

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

Definition at line 37 of file qgsmeshdataset.cpp.

◆ operator!=()

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

Inequality operator.

Definition at line 50 of file qgsmeshdataset.cpp.

◆ operator==()

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

Equality operator.

Definition at line 42 of file qgsmeshdataset.cpp.

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

/build/qgis-3.26.3+32focal/src/core/mesh/qgsmeshdataset.h
/build/qgis-3.26.3+32focal/src/core/mesh/qgsmeshdataset.cpp

Public Member Functions