QgsMeshDatasetMetadata is a collection of mesh dataset metadata such as whether the data is valid or associated time for the dataset. More...

#include <qgsmeshdataset.h>

Public Member Functions
	QgsMeshDatasetMetadata ()=default
	Constructs an empty metadata object.

	QgsMeshDatasetMetadata (double time, bool isValid, double minimum, double maximum, int maximumVerticalLevels)
	Constructs a valid metadata object.

bool	isValid () const
	Returns whether dataset is valid.

double	maximum () const
	Returns maximum scalar value/vector magnitude present for the dataset.

int	maximumVerticalLevelsCount () const
	Returns maximum number of vertical levels for 3d stacked meshes.

double	minimum () const
	Returns minimum scalar value/vector magnitude present for the dataset.

double	time () const
	Returns the time value for this dataset.

Detailed Description

QgsMeshDatasetMetadata is a collection of mesh dataset metadata such as whether the data is valid or associated time for the dataset.

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

Since: QGIS 3.2

Definition at line 481 of file qgsmeshdataset.h.

Constructor & Destructor Documentation

◆ QgsMeshDatasetMetadata() [1/2]

QgsMeshDatasetMetadata::QgsMeshDatasetMetadata ( )

default

Constructs an empty metadata object.

◆ QgsMeshDatasetMetadata() [2/2]

QgsMeshDatasetMetadata::QgsMeshDatasetMetadata	(	double	time,
		bool	isValid,
		double	minimum,
		double	maximum,
		int	maximumVerticalLevels
	)

Constructs a valid metadata object.

Parameters

time	a time which this dataset represents in the dataset group
isValid	dataset is loadad and valid for fetching the data
minimum	minimum value (magnitude for vectors) present among dataset values
maximum	maximum value (magnitude for vectors) present among dataset values
maximumVerticalLevels	maximum number of vertical levels for 3d stacked meshes, 0 for 2d meshes

Definition at line 202 of file qgsmeshdataset.cpp.

Member Function Documentation

◆ isValid()

bool QgsMeshDatasetMetadata::isValid ( ) const

Returns whether dataset is valid.

Definition at line 221 of file qgsmeshdataset.cpp.

◆ maximum()

double QgsMeshDatasetMetadata::maximum ( ) const

Returns maximum scalar value/vector magnitude present for the dataset.

Definition at line 231 of file qgsmeshdataset.cpp.

◆ maximumVerticalLevelsCount()

int QgsMeshDatasetMetadata::maximumVerticalLevelsCount ( ) const

Returns maximum number of vertical levels for 3d stacked meshes.

Since: QGIS 3.12

Definition at line 236 of file qgsmeshdataset.cpp.

◆ minimum()

double QgsMeshDatasetMetadata::minimum ( ) const

Returns minimum scalar value/vector magnitude present for the dataset.

Definition at line 226 of file qgsmeshdataset.cpp.

◆ time()

double QgsMeshDatasetMetadata::time ( ) const

Returns the time value for this dataset.

Definition at line 216 of file qgsmeshdataset.cpp.

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

/build/qgis-3.34.0+99sid/src/core/mesh/qgsmeshdataset.h
/build/qgis-3.34.0+99sid/src/core/mesh/qgsmeshdataset.cpp

Public Member Functions