QgsMeshDatasetGroupMetadata is a collection of dataset group metadata such as whether the data is vector or scalar, name. More...

#include <qgsmeshdataprovider.h>

Public Types
enum	DataType { DataOnFaces = 0, DataOnVertices, DataOnVolumes }
	Location of where data is specified for datasets in the dataset group. More...

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

	QgsMeshDatasetGroupMetadata (const QString &name, bool isScalar, DataType dataType, double minimum, double maximum, int maximumVerticalLevels, const QDateTime &referenceTime, const QMap< QString, QString > &extraOptions)
	Constructs a valid metadata object. More...

DataType	dataType () const
	Returns whether dataset group data is defined on vertices or faces or volumes. More...

QMap< QString, QString >	extraOptions () const
	Returns extra metadata options, for example description. More...

bool	isScalar () const
	Returns whether dataset group has scalar data. More...

bool	isVector () const
	Returns whether dataset group has vector data. More...

double	maximum () const
	Returns maximum scalar value/vector magnitude present for whole dataset group. More...

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

double	minimum () const
	Returns minimum scalar value/vector magnitude present for whole dataset group. More...

QString	name () const
	Returns name of the dataset group. More...

QDateTime	referenceTime () const
	Returns the reference time. More...

Detailed Description

QgsMeshDatasetGroupMetadata is a collection of dataset group metadata such as whether the data is vector or scalar, name.

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

Since: QGIS 3.4

Definition at line 376 of file qgsmeshdataprovider.h.

Member Enumeration Documentation

◆ DataType

enum QgsMeshDatasetGroupMetadata::DataType

Location of where data is specified for datasets in the dataset group.

Enumerator

DataOnFaces

Data is defined on faces.

DataOnVertices

Data is defined on vertices.

DataOnVolumes

Data is defined on volumes.

Since: QGIS 3.12

Definition at line 381 of file qgsmeshdataprovider.h.

Constructor & Destructor Documentation

◆ QgsMeshDatasetGroupMetadata() [1/2]

QgsMeshDatasetGroupMetadata::QgsMeshDatasetGroupMetadata ( )

default

Constructs an empty metadata object.

◆ QgsMeshDatasetGroupMetadata() [2/2]

QgsMeshDatasetGroupMetadata::QgsMeshDatasetGroupMetadata	(	const QString &	name,
		bool	isScalar,
		DataType	dataType,
		double	minimum,
		double	maximum,
		int	maximumVerticalLevels,
		const QDateTime &	referenceTime,
		const QMap< QString, QString > &	extraOptions
	)

Constructs a valid metadata object.

Parameters

name	name of the dataset group
isScalar	dataset contains scalar data, specifically the y-value of QgsMeshDatasetValue is NaN
dataType	where the data are defined on (vertices, faces or volumes)
minimum	minimum value (magnitude for vectors) present among all group's dataset values
maximum	maximum value (magnitude for vectors) present among all group's dataset values
maximumVerticalLevels	maximum number of vertical levels for 3d stacked meshes, 0 for 2d meshes
referenceTime	reference time of the dataset group
extraOptions	dataset's extra options stored by the provider. Usually contains the name, time value, time units, data file vendor, ...

Definition at line 130 of file qgsmeshdataprovider.cpp.

Member Function Documentation

◆ dataType()

QgsMeshDatasetGroupMetadata::DataType QgsMeshDatasetGroupMetadata::dataType ( ) const

Returns whether dataset group data is defined on vertices or faces or volumes.

Since: QGIS 3.12

Definition at line 169 of file qgsmeshdataprovider.cpp.

◆ extraOptions()

QMap< QString, QString > QgsMeshDatasetGroupMetadata::extraOptions ( ) const

Returns extra metadata options, for example description.

Definition at line 149 of file qgsmeshdataprovider.cpp.

◆ isScalar()

bool QgsMeshDatasetGroupMetadata::isScalar ( ) const

Returns whether dataset group has scalar data.

Definition at line 159 of file qgsmeshdataprovider.cpp.

◆ isVector()

bool QgsMeshDatasetGroupMetadata::isVector ( ) const

Returns whether dataset group has vector data.

Definition at line 154 of file qgsmeshdataprovider.cpp.

◆ maximum()

double QgsMeshDatasetGroupMetadata::maximum ( ) const

Returns maximum scalar value/vector magnitude present for whole dataset group.

Definition at line 179 of file qgsmeshdataprovider.cpp.

◆ maximumVerticalLevelsCount()

int QgsMeshDatasetGroupMetadata::maximumVerticalLevelsCount ( ) const

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

Since: QGIS 3.12

Definition at line 184 of file qgsmeshdataprovider.cpp.

◆ minimum()

double QgsMeshDatasetGroupMetadata::minimum ( ) const

Returns minimum scalar value/vector magnitude present for whole dataset group.

Definition at line 174 of file qgsmeshdataprovider.cpp.

◆ name()

QString QgsMeshDatasetGroupMetadata::name ( ) const

Returns name of the dataset group.

Definition at line 164 of file qgsmeshdataprovider.cpp.

◆ referenceTime()

QDateTime QgsMeshDatasetGroupMetadata::referenceTime ( ) const

Returns the reference time.

Since: QGIS 3.12

Definition at line 189 of file qgsmeshdataprovider.cpp.

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

/build/qgis-3.12.1+28bionic/src/core/mesh/qgsmeshdataprovider.h
/build/qgis-3.12.1+28bionic/src/core/mesh/qgsmeshdataprovider.cpp

Public Types

Public Member Functions