QGIS API Documentation  3.4.3-Madeira (2f64a3c)
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 <qgsmeshdataprovider.h>

Public Types

enum  DataType { DataOnFaces, DataOnVertices }
 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, bool isScalar, bool isOnVertices, 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. 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 isVector () const
 Returns whether dataset group has vector data. More...
 
QString name () const
 Returns name of the dataset group. 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 130 of file qgsmeshdataprovider.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.

Definition at line 135 of file qgsmeshdataprovider.h.

Constructor & Destructor Documentation

◆ QgsMeshDatasetGroupMetadata() [1/2]

QgsMeshDatasetGroupMetadata::QgsMeshDatasetGroupMetadata ( )
default

Constructs an empty metadata object.

◆ QgsMeshDatasetGroupMetadata() [2/2]

QgsMeshDatasetGroupMetadata::QgsMeshDatasetGroupMetadata ( const QString &  name,
bool  isScalar,
bool  isOnVertices,
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
isOnVerticesdataset values are defined on mesh's vertices. If false, values are defined on faces.
extraOptionsdataset's extra options stored by the provider. Usually contains the name, time value, time units, data file vendor, ...

Definition at line 147 of file qgsmeshdataprovider.cpp.

Member Function Documentation

◆ dataType()

QgsMeshDatasetGroupMetadata::DataType QgsMeshDatasetGroupMetadata::dataType ( ) const

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

Definition at line 181 of file qgsmeshdataprovider.cpp.

◆ extraOptions()

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

Returns extra metadata options, for example description.

Definition at line 159 of file qgsmeshdataprovider.cpp.

◆ isScalar()

bool QgsMeshDatasetGroupMetadata::isScalar ( ) const

Returns whether dataset group has scalar data.

Definition at line 169 of file qgsmeshdataprovider.cpp.

◆ isVector()

bool QgsMeshDatasetGroupMetadata::isVector ( ) const

Returns whether dataset group has vector data.

Definition at line 164 of file qgsmeshdataprovider.cpp.

◆ name()

QString QgsMeshDatasetGroupMetadata::name ( ) const

Returns name of the dataset group.

Definition at line 176 of file qgsmeshdataprovider.cpp.


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