QGIS API Documentation 3.41.0-Master (d5b93354e9c)
|
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. | |
QgsMeshDatasetGroupMetadata is a collection of dataset group metadata such as whether the data is vector or scalar, name.
Definition at line 354 of file qgsmeshdataset.h.
Location of where data is specified for datasets in the dataset group.
Definition at line 359 of file qgsmeshdataset.h.
|
default |
Constructs an empty metadata object.
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.
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.
QgsMeshDatasetGroupMetadata::DataType QgsMeshDatasetGroupMetadata::dataType | ( | ) | const |
Returns whether dataset group data is defined on vertices or faces or volumes.
Definition at line 188 of file qgsmeshdataset.cpp.
QMap< QString, QString > QgsMeshDatasetGroupMetadata::extraOptions | ( | ) | const |
Returns extra metadata options, for example description.
Definition at line 157 of file qgsmeshdataset.cpp.
bool QgsMeshDatasetGroupMetadata::isScalar | ( | ) | const |
Returns whether dataset group has scalar data.
Definition at line 167 of file qgsmeshdataset.cpp.
bool QgsMeshDatasetGroupMetadata::isTemporal | ( | ) | const |
Returns whether the dataset group is temporal (contains time-related dataset)
Definition at line 172 of file qgsmeshdataset.cpp.
bool QgsMeshDatasetGroupMetadata::isVector | ( | ) | const |
Returns whether dataset group has vector data.
Definition at line 162 of file qgsmeshdataset.cpp.
double QgsMeshDatasetGroupMetadata::maximum | ( | ) | const |
Returns maximum scalar value/vector magnitude present for whole dataset group.
Definition at line 198 of file qgsmeshdataset.cpp.
int QgsMeshDatasetGroupMetadata::maximumVerticalLevelsCount | ( | ) | const |
Returns maximum number of vertical levels for 3d stacked meshes.
Definition at line 203 of file qgsmeshdataset.cpp.
double QgsMeshDatasetGroupMetadata::minimum | ( | ) | const |
Returns minimum scalar value/vector magnitude present for whole dataset group.
Definition at line 193 of file qgsmeshdataset.cpp.
QString QgsMeshDatasetGroupMetadata::name | ( | ) | const |
Returns name of the dataset group.
Definition at line 177 of file qgsmeshdataset.cpp.
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).
Definition at line 182 of file qgsmeshdataset.cpp.
QDateTime QgsMeshDatasetGroupMetadata::referenceTime | ( | ) | const |
QString QgsMeshDatasetGroupMetadata::uri | ( | ) | const |