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

Public Types
enum	DataType { DataOnFaces, DataOnVertices }
	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, bool isOnVertices, 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. 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...

QString	name () const
	Returns name of the dataset group. 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

Definition at line 130 of file qgsmeshdataprovider.h.

Member Enumeration Documentation

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.

Definition at line 135 of file qgsmeshdataprovider.h.

QgsMeshDatasetGroupMetadata::QgsMeshDatasetGroupMetadata ( )

default

Constructs an empty metadata object.

QgsMeshDatasetGroupMetadata::QgsMeshDatasetGroupMetadata	(	const QString &	name,
		bool	isScalar,
		bool	isOnVertices,
		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
isOnVertices	dataset values are defined on mesh's vertices. If false, values are defined on faces.
extraOptions	dataset's extra options stored by the provider. Usually contains the name, time value, time units, data file vendor, ...

Definition at line 147 of file qgsmeshdataprovider.cpp.

QgsMeshDatasetGroupMetadata::DataType QgsMeshDatasetGroupMetadata::dataType ( ) const

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

Definition at line 181 of file qgsmeshdataprovider.cpp.

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

Returns extra metadata options, for example description.

Definition at line 159 of file qgsmeshdataprovider.cpp.

bool QgsMeshDatasetGroupMetadata::isScalar ( ) const

Returns whether dataset group has scalar data.

Definition at line 169 of file qgsmeshdataprovider.cpp.

bool QgsMeshDatasetGroupMetadata::isVector ( ) const

Returns whether dataset group has vector data.

Definition at line 164 of file qgsmeshdataprovider.cpp.

QString QgsMeshDatasetGroupMetadata::name ( ) const

Returns name of the dataset group.

Definition at line 176 of file qgsmeshdataprovider.cpp.

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