QgsMeshDatasetMetadata is a collection of mesh dataset metadata such as whether the data is vector or scalar, etc. More...

#include <qgsmeshdataprovider.h>

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

	QgsMeshDatasetMetadata (bool isScalar, bool isValid, bool isOnVertices, const QMap< QString, QString > &extraOptions)
	Constructs a valid metadata object. More...

QMap< QString, QString >	extraOptions () const
	Returns extra metadata options Usually including name, description or time variable. More...

bool	isOnVertices () const
	Returns whether dataset data is defined on vertices. More...

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

bool	isValid () const
	Returns whether dataset is valid. More...

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

Detailed Description

QgsMeshDatasetMetadata is a collection of mesh dataset metadata such as whether the data is vector or scalar, etc.

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

Since: QGIS 3.2

Definition at line 101 of file qgsmeshdataprovider.h.

Constructor & Destructor Documentation

◆ QgsMeshDatasetMetadata() [1/2]

QgsMeshDatasetMetadata::QgsMeshDatasetMetadata ( )

default

Constructs an empty metadata object.

◆ QgsMeshDatasetMetadata() [2/2]

QgsMeshDatasetMetadata::QgsMeshDatasetMetadata	(	bool	isScalar,
		bool	isValid,
		bool	isOnVertices,
		const QMap< QString, QString > &	extraOptions
	)

Constructs a valid metadata object.

Parameters

isScalar	dataset contains scalar data, specifically the y-value of QgsMeshDatasetValue is NaN
isValid	dataset is loadad and valid for fetching the data
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 112 of file qgsmeshdataprovider.cpp.

Member Function Documentation

◆ extraOptions()

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

Returns extra metadata options Usually including name, description or time variable.

Definition at line 124 of file qgsmeshdataprovider.cpp.

◆ isOnVertices()

bool QgsMeshDatasetMetadata::isOnVertices ( ) const

Returns whether dataset data is defined on vertices.

Definition at line 145 of file qgsmeshdataprovider.cpp.

◆ isScalar()

bool QgsMeshDatasetMetadata::isScalar ( ) const

Returns whether dataset has scalar data.

Definition at line 134 of file qgsmeshdataprovider.cpp.

◆ isValid()

bool QgsMeshDatasetMetadata::isValid ( ) const

Returns whether dataset is valid.

Definition at line 139 of file qgsmeshdataprovider.cpp.

◆ isVector()

bool QgsMeshDatasetMetadata::isVector ( ) const

Returns whether dataset has vector data.

Definition at line 129 of file qgsmeshdataprovider.cpp.

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

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

Public Member Functions