QGIS API Documentation  3.13.0-Master (7f54853aae)
Public Member Functions | List of all members
QgsMeshDatasetMetadata Class Reference

QgsMeshDatasetMetadata is a collection of mesh dataset metadata such as whether the data is valid or associated time for the dataset. More...

#include <qgsmeshdataprovider.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...
 

Detailed Description

QgsMeshDatasetMetadata is a collection of mesh dataset metadata such as whether the data is valid or associated time for the dataset.

Note
The API is considered EXPERIMENTAL and can be changed without a notice
Since
QGIS 3.2

Definition at line 484 of file qgsmeshdataprovider.h.

Constructor & Destructor Documentation

◆ QgsMeshDatasetMetadata() [1/2]

QgsMeshDatasetMetadata::QgsMeshDatasetMetadata ( )
default

Constructs an empty metadata object.

◆ QgsMeshDatasetMetadata() [2/2]

QgsMeshDatasetMetadata::QgsMeshDatasetMetadata ( double  time,
bool  isValid,
double  minimum,
double  maximum,
int  maximumVerticalLevels 
)

Constructs a valid metadata object.

Parameters
timea time which this dataset represents in the dataset group
isValiddataset is loadad and valid for fetching the data
minimumminimum value (magnitude for vectors) present among dataset values
maximummaximum value (magnitude for vectors) present among dataset values
maximumVerticalLevelsmaximum number of vertical levels for 3d stacked meshes, 0 for 2d meshes

Definition at line 204 of file qgsmeshdataprovider.cpp.

Member Function Documentation

◆ isValid()

bool QgsMeshDatasetMetadata::isValid ( ) const

Returns whether dataset is valid.

Definition at line 223 of file qgsmeshdataprovider.cpp.

◆ maximum()

double QgsMeshDatasetMetadata::maximum ( ) const

Returns maximum scalar value/vector magnitude present for the dataset.

Definition at line 233 of file qgsmeshdataprovider.cpp.

◆ maximumVerticalLevelsCount()

int QgsMeshDatasetMetadata::maximumVerticalLevelsCount ( ) const

Returns maximum number of vertical levels for 3d stacked meshes.

Since
QGIS 3.12

Definition at line 238 of file qgsmeshdataprovider.cpp.

◆ minimum()

double QgsMeshDatasetMetadata::minimum ( ) const

Returns minimum scalar value/vector magnitude present for the dataset.

Definition at line 228 of file qgsmeshdataprovider.cpp.

◆ time()

double QgsMeshDatasetMetadata::time ( ) const

Returns the time value for this dataset.

Definition at line 218 of file qgsmeshdataprovider.cpp.


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