QgsMeshDatasetGroupMetadata class

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

Public types

enum DataType { DataOnFaces, DataOnVertices }: Location of where data is specified for datasets in the dataset group.

QgsMeshDatasetGroupMetadata() defaulted: Constructs an empty metadata object.
QgsMeshDatasetGroupMetadata(const QString& name, bool isScalar, bool isOnVertices, double minimum, double maximum, const QMap<QString, QString>& extraOptions): Constructs a valid metadata object.

auto dataType() const -> DataType: Returns whether dataset group data is defined on vertices or faces.
auto extraOptions() const -> QMap<QString, QString>: Returns extra metadata options, for example description.
auto isScalar() const -> bool: Returns whether dataset group has scalar data.
auto isVector() const -> bool: Returns whether dataset group has vector data.
auto maximum() const -> double: Returns maximum scalar value/vector magnitude present for whole dataset group.
auto minimum() const -> double: Returns minimum scalar value/vector magnitude present for whole dataset group.
auto name() const -> QString: Returns name of the dataset group.

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

Enumerators
DataOnFaces	Data is defined on faces.
DataOnVertices	Data is defined on vertices.

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.
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
extraOptions	dataset's extra options stored by the provider. Usually contains the name, time value, time units, data file vendor, ...