QgsMeshDatasetMetadata Class Reference

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

#include <qgsmeshdataprovider.h>

Public Member Functions
	QgsMeshDatasetMetadata ()=default
	Constructs an empty metadata object. More...
	QgsMeshDatasetMetadata (double time, bool isValid, double minimum, double maximum)
	Constructs a valid metadata object. More...
bool	isValid () const
	Returns whether dataset is valid. More...
double	maximum () const
	Returns maximum scalar value/vector magnitude present for the dataset. More...
double	minimum () const
	Returns minimum scalar value/vector magnitude present for the dataset. More...
double	time () const
	Returns the time value for this dataset. More...

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 325 of file qgsmeshdataprovider.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
	)

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

Definition at line 190 of file qgsmeshdataprovider.cpp.

Member Function Documentation

isValid()

bool QgsMeshDatasetMetadata::isValid

(

)

const

Returns whether dataset is valid.

Definition at line 206 of file qgsmeshdataprovider.cpp.

maximum()

double QgsMeshDatasetMetadata::maximum

(

)

const

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

Definition at line 216 of file qgsmeshdataprovider.cpp.

minimum()

double QgsMeshDatasetMetadata::minimum

(

)

const

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

Definition at line 211 of file qgsmeshdataprovider.cpp.

time()

double QgsMeshDatasetMetadata::time

(

)

const

Returns the time value for this dataset.

Definition at line 201 of file qgsmeshdataprovider.cpp.

---

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

• /tmp/buildd/qgis-3.6.0+99unstable/src/core/mesh/qgsmeshdataprovider.h
• /tmp/buildd/qgis-3.6.0+99unstable/src/core/mesh/qgsmeshdataprovider.cpp