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

#include <qgsmeshdataset.h>

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

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

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

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

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

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

bool	isTemporal () const
	Returns whether the dataset group is temporal (contains time-related dataset)

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

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

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

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

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

QString	parentQuantityName () const
	Returns the name of the dataset's parent quantity, if available.

QDateTime	referenceTime () const
	Returns the reference time.

QString	uri () const
	Returns the uri of the source.

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 354 of file qgsmeshdataset.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
DataOnEdges	Data is defined on edges. Since QGIS 3.14

Definition at line 359 of file qgsmeshdataset.h.

Constructor & Destructor Documentation

◆ QgsMeshDatasetGroupMetadata() [1/2]

QgsMeshDatasetGroupMetadata::QgsMeshDatasetGroupMetadata ( )

default

Constructs an empty metadata object.

◆ QgsMeshDatasetGroupMetadata() [2/2]

QgsMeshDatasetGroupMetadata::QgsMeshDatasetGroupMetadata	(	const QString &	name,
		const QString	uri,
		bool	isScalar,
		DataType	dataType,
		double	minimum,
		double	maximum,
		int	maximumVerticalLevels,
		const QDateTime &	referenceTime,
		bool	isTemporal,
		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
isTemporal	weither the dataset group is temporal (contains time-related dataset)
extraOptions	dataset's extra options stored by the provider. Usually contains the name, time value, time units, data file vendor, ...
uri	The uri of the dataset

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

◆ extraOptions()

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

Returns extra metadata options, for example description.

Definition at line 157 of file qgsmeshdataset.cpp.

◆ isScalar()

bool QgsMeshDatasetGroupMetadata::isScalar ( ) const

Returns whether dataset group has scalar data.

Definition at line 167 of file qgsmeshdataset.cpp.

◆ isTemporal()

bool QgsMeshDatasetGroupMetadata::isTemporal ( ) const

Returns whether the dataset group is temporal (contains time-related dataset)

Definition at line 172 of file qgsmeshdataset.cpp.

◆ isVector()

bool QgsMeshDatasetGroupMetadata::isVector ( ) const

Returns whether dataset group has vector data.

Definition at line 162 of file qgsmeshdataset.cpp.

◆ maximum()

double QgsMeshDatasetGroupMetadata::maximum ( ) const

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

Definition at line 198 of file qgsmeshdataset.cpp.

◆ maximumVerticalLevelsCount()

int QgsMeshDatasetGroupMetadata::maximumVerticalLevelsCount ( ) const

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

Since: QGIS 3.12

Definition at line 203 of file qgsmeshdataset.cpp.

◆ minimum()

double QgsMeshDatasetGroupMetadata::minimum ( ) const

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

Definition at line 193 of file qgsmeshdataset.cpp.

◆ name()

QString QgsMeshDatasetGroupMetadata::name ( ) const

Returns name of the dataset group.

Definition at line 177 of file qgsmeshdataset.cpp.

◆ parentQuantityName()

QString QgsMeshDatasetGroupMetadata::parentQuantityName ( ) const

Returns the name of the dataset's parent quantity, if available.

The quantity can be used to collect dataset groups which represent a single quantity but at different values (e.g. groups which represent different elevations).

Since: QGIS 3.38

Definition at line 182 of file qgsmeshdataset.cpp.

◆ referenceTime()

QDateTime QgsMeshDatasetGroupMetadata::referenceTime ( ) const

Returns the reference time.

Since: QGIS 3.12

Definition at line 208 of file qgsmeshdataset.cpp.

◆ uri()

QString QgsMeshDatasetGroupMetadata::uri ( ) const

Returns the uri of the source.

Since: QGIS 3.16

Definition at line 213 of file qgsmeshdataset.cpp.

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

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

Public Types

Public Member Functions