QGIS API Documentation  3.21.0-Master (5b68dc587e)
Public Types | Public Member Functions | List of all members
QgsMeshDatasetGroupMetadata Class Reference

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. More...
 
 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. More...
 
DataType dataType () const
 Returns whether dataset group data is defined on vertices or faces or volumes. More...
 
QMap< QString, QString > extraOptions () const
 Returns extra metadata options, for example description. More...
 
bool isScalar () const
 Returns whether dataset group has scalar data. More...
 
bool isTemporal () const
 Returns whether the dataset group is temporal (contains time-related dataset) More...
 
bool isVector () const
 Returns whether dataset group has vector data. More...
 
double maximum () const
 Returns maximum scalar value/vector magnitude present for whole dataset group. 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 whole dataset group. More...
 
QString name () const
 Returns name of the dataset group. More...
 
QDateTime referenceTime () const
 Returns the reference time. More...
 
QString uri () const
 Returns the uri of the source. More...
 

Detailed Description

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

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

Definition at line 351 of file qgsmeshdataset.h.

Member Enumeration Documentation

◆ DataType

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

Enumerator
DataOnFaces 

Data is defined on faces.

DataOnVertices 

Data is defined on vertices.

DataOnVolumes 

Data is defined on volumes.

Since
QGIS 3.12
DataOnEdges 

Data is defined on edges.

Since
QGIS 3.14

Definition at line 356 of file qgsmeshdataset.h.

Constructor & Destructor Documentation

◆ QgsMeshDatasetGroupMetadata() [1/2]

QgsMeshDatasetGroupMetadata::QgsMeshDatasetGroupMetadata ( )
default

Constructs an empty metadata object.

◆ QgsMeshDatasetGroupMetadata() [2/2]

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.

Parameters
namename of the dataset group
isScalardataset contains scalar data, specifically the y-value of QgsMeshDatasetValue is NaN
dataTypewhere the data are defined on (vertices, faces or volumes)
minimumminimum value (magnitude for vectors) present among all group's dataset values
maximummaximum value (magnitude for vectors) present among all group's dataset values
maximumVerticalLevelsmaximum number of vertical levels for 3d stacked meshes, 0 for 2d meshes
referenceTimereference time of the dataset group
isTemporalweither the dataset group is temporal (contains time-related dataset)
extraOptionsdataset's extra options stored by the provider. Usually contains the name, time value, time units, data file vendor, ...
uriThe uri of the dataset

Definition at line 124 of file qgsmeshdataset.cpp.

Member Function Documentation

◆ dataType()

QgsMeshDatasetGroupMetadata::DataType QgsMeshDatasetGroupMetadata::dataType ( ) const

Returns whether dataset group data is defined on vertices or faces or volumes.

Since
QGIS 3.12

Definition at line 172 of file qgsmeshdataset.cpp.

◆ extraOptions()

QMap< QString, QString > QgsMeshDatasetGroupMetadata::extraOptions ( ) const

Returns extra metadata options, for example description.

Definition at line 147 of file qgsmeshdataset.cpp.

◆ isScalar()

bool QgsMeshDatasetGroupMetadata::isScalar ( ) const

Returns whether dataset group has scalar data.

Definition at line 157 of file qgsmeshdataset.cpp.

◆ isTemporal()

bool QgsMeshDatasetGroupMetadata::isTemporal ( ) const

Returns whether the dataset group is temporal (contains time-related dataset)

Definition at line 162 of file qgsmeshdataset.cpp.

◆ isVector()

bool QgsMeshDatasetGroupMetadata::isVector ( ) const

Returns whether dataset group has vector data.

Definition at line 152 of file qgsmeshdataset.cpp.

◆ maximum()

double QgsMeshDatasetGroupMetadata::maximum ( ) const

Returns maximum scalar value/vector magnitude present for whole dataset group.

Definition at line 182 of file qgsmeshdataset.cpp.

◆ maximumVerticalLevelsCount()

int QgsMeshDatasetGroupMetadata::maximumVerticalLevelsCount ( ) const

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

Since
QGIS 3.12

Definition at line 187 of file qgsmeshdataset.cpp.

◆ minimum()

double QgsMeshDatasetGroupMetadata::minimum ( ) const

Returns minimum scalar value/vector magnitude present for whole dataset group.

Definition at line 177 of file qgsmeshdataset.cpp.

◆ name()

QString QgsMeshDatasetGroupMetadata::name ( ) const

Returns name of the dataset group.

Definition at line 167 of file qgsmeshdataset.cpp.

◆ referenceTime()

QDateTime QgsMeshDatasetGroupMetadata::referenceTime ( ) const

Returns the reference time.

Since
QGIS 3.12

Definition at line 192 of file qgsmeshdataset.cpp.

◆ uri()

QString QgsMeshDatasetGroupMetadata::uri ( ) const

Returns the uri of the source.

Since
QGIS 3.16

Definition at line 197 of file qgsmeshdataset.cpp.


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