QGIS API Documentation
3.20.0-Odense (decaadbb31)
|
QgsMeshDatasetMetadata is a collection of mesh dataset metadata such as whether the data is valid or associated time for the dataset. More...
#include <qgsmeshdataset.h>
Public Member Functions | |
QgsMeshDatasetMetadata ()=default | |
Constructs an empty metadata object. More... | |
QgsMeshDatasetMetadata (double time, bool isValid, double minimum, double maximum, int maximumVerticalLevels) | |
Constructs a valid metadata object. More... | |
bool | isValid () const |
Returns whether dataset is valid. More... | |
double | maximum () const |
Returns maximum scalar value/vector magnitude present for the dataset. More... | |
int | maximumVerticalLevelsCount () const |
Returns maximum number of vertical levels for 3d stacked meshes. More... | |
double | minimum () const |
Returns minimum scalar value/vector magnitude present for the dataset. More... | |
double | time () const |
Returns the time value for this dataset. More... | |
QgsMeshDatasetMetadata is a collection of mesh dataset metadata such as whether the data is valid or associated time for the dataset.
Definition at line 477 of file qgsmeshdataset.h.
|
default |
Constructs an empty metadata object.
QgsMeshDatasetMetadata::QgsMeshDatasetMetadata | ( | double | time, |
bool | isValid, | ||
double | minimum, | ||
double | maximum, | ||
int | maximumVerticalLevels | ||
) |
Constructs a valid metadata object.
time | a time which this dataset represents in the dataset group |
isValid | dataset is loadad and valid for fetching the data |
minimum | minimum value (magnitude for vectors) present among dataset values |
maximum | maximum value (magnitude for vectors) present among dataset values |
maximumVerticalLevels | maximum number of vertical levels for 3d stacked meshes, 0 for 2d meshes |
Definition at line 201 of file qgsmeshdataset.cpp.
bool QgsMeshDatasetMetadata::isValid | ( | ) | const |
Returns whether dataset is valid.
Definition at line 220 of file qgsmeshdataset.cpp.
double QgsMeshDatasetMetadata::maximum | ( | ) | const |
Returns maximum scalar value/vector magnitude present for the dataset.
Definition at line 230 of file qgsmeshdataset.cpp.
int QgsMeshDatasetMetadata::maximumVerticalLevelsCount | ( | ) | const |
Returns maximum number of vertical levels for 3d stacked meshes.
Definition at line 235 of file qgsmeshdataset.cpp.
double QgsMeshDatasetMetadata::minimum | ( | ) | const |
Returns minimum scalar value/vector magnitude present for the dataset.
Definition at line 225 of file qgsmeshdataset.cpp.
double QgsMeshDatasetMetadata::time | ( | ) | const |
Returns the time value for this dataset.
Definition at line 215 of file qgsmeshdataset.cpp.