QGIS API Documentation  3.4.3-Madeira (2f64a3c)
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)
 Constructs a valid metadata object. More...
 
bool isValid () const
 Returns whether dataset is valid. 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 199 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 
)

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

Definition at line 196 of file qgsmeshdataprovider.cpp.

Member Function Documentation

◆ isValid()

bool QgsMeshDatasetMetadata::isValid ( ) const

Returns whether dataset is valid.

Definition at line 208 of file qgsmeshdataprovider.cpp.

◆ time()

double QgsMeshDatasetMetadata::time ( ) const

Returns the time value for this dataset.

Definition at line 203 of file qgsmeshdataprovider.cpp.


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