QGIS API Documentation  3.21.0-Master (5b68dc587e)
Public Types | Public Member Functions | Protected Attributes | List of all members
QgsMeshDatasetGroup Class Referenceabstract

Abstract class that represents a dataset group. More...

#include <qgsmeshdataset.h>

Inheritance diagram for QgsMeshDatasetGroup:
Inheritance graph
[legend]

Public Types

enum  Type { None , Persistent , Memory , Virtual }
 Type of the dataset group. More...
 

Public Member Functions

 QgsMeshDatasetGroup ()=default
 Default constructor. More...
 
 QgsMeshDatasetGroup (const QString &name)
 Constructor with the name of the dataset group. More...
 
 QgsMeshDatasetGroup (const QString &name, QgsMeshDatasetGroupMetadata::DataType dataType)
 Constructor with the name of the dataset group and the dataTYpe. More...
 
virtual ~QgsMeshDatasetGroup ()
 
void addExtraMetadata (QString key, QString value)
 Adds extra metadata to the group. More...
 
void calculateStatistic ()
 Calculates the statistics (minimum and maximum) More...
 
bool checkValueCountPerDataset (int count) const
 Returns whether all the datasets contain count values. More...
 
virtual QgsMeshDatasetdataset (int index) const =0
 Returns the dataset with index. More...
 
virtual int datasetCount () const =0
 Returns the count of datasets in the group. More...
 
virtual QStringList datasetGroupNamesDependentOn () const
 Returns the dataset group variable name which this dataset group depends on. More...
 
virtual QgsMeshDatasetMetadata datasetMetadata (int datasetIndex) const =0
 Returns the metadata of the dataset with index datasetIndex. More...
 
QgsMeshDatasetGroupMetadata::DataType dataType () const
 Returns the data type of the dataset group. More...
 
virtual QString description () const
 Returns some information about the dataset group. More...
 
QMap< QString, QString > extraMetadata () const
 Returns all the extra metadata of the group. More...
 
QgsMeshDatasetGroupMetadata groupMetadata () const
 Returns the metadata of the dataset group. More...
 
virtual void initialize ()=0
 Initialize the dataset group. More...
 
bool isScalar () const
 Returns whether the group contain scalar values. More...
 
double maximum () const
 Returns the maximum value of the whole dataset group. More...
 
double minimum () const
 Returns the minimum value of the whole dataset group. More...
 
QString name () const
 Returns the name of the dataset group. More...
 
void setDataType (const QgsMeshDatasetGroupMetadata::DataType &dataType)
 Sets the data type of the dataset group. More...
 
void setIsScalar (bool isScalar)
 Sets whether the group contain scalar values. More...
 
void setMinimumMaximum (double min, double max)
 Overrides the minimum and the maximum value of the whole dataset group. More...
 
void setName (const QString &name)
 Sets the name of the dataset group. More...
 
void setReferenceTime (const QDateTime &referenceTime)
 Sets the reference time of the dataset group. More...
 
void setStatisticObsolete ()
 Sets statistic obsolete, that means statistic will be recalculated when requested. More...
 
virtual QgsMeshDatasetGroup::Type type () const =0
 Returns the type of dataset group. More...
 
virtual QDomElement writeXml (QDomDocument &doc, const QgsReadWriteContext &context) const =0
 Write dataset group information in a DOM element. More...
 

Protected Attributes

QgsMeshDatasetGroupMetadata::DataType mDataType = QgsMeshDatasetGroupMetadata::DataOnVertices
 
bool mIsScalar = true
 
QMap< QString, QString > mMetadata
 
QString mName
 

Detailed Description

Abstract class that represents a dataset group.

Since
QGIS 3.16

Definition at line 578 of file qgsmeshdataset.h.

Member Enumeration Documentation

◆ Type

Type of the dataset group.

Since
QGIS 3.16
Enumerator
None 
Persistent 

Generic type used for non typed dataset group.

Memory 

Dataset group store in a file.

Virtual 

Temporary dataset group in memory.

Definition at line 587 of file qgsmeshdataset.h.

Constructor & Destructor Documentation

◆ QgsMeshDatasetGroup() [1/3]

QgsMeshDatasetGroup::QgsMeshDatasetGroup ( )
default

Default constructor.

◆ ~QgsMeshDatasetGroup()

QgsMeshDatasetGroup::~QgsMeshDatasetGroup ( )
virtualdefault

◆ QgsMeshDatasetGroup() [2/3]

QgsMeshDatasetGroup::QgsMeshDatasetGroup ( const QString &  name)

Constructor with the name of the dataset group.

Definition at line 1035 of file qgsmeshdataset.cpp.

◆ QgsMeshDatasetGroup() [3/3]

QgsMeshDatasetGroup::QgsMeshDatasetGroup ( const QString &  name,
QgsMeshDatasetGroupMetadata::DataType  dataType 
)

Constructor with the name of the dataset group and the dataTYpe.

Definition at line 1030 of file qgsmeshdataset.cpp.

Member Function Documentation

◆ addExtraMetadata()

void QgsMeshDatasetGroup::addExtraMetadata ( QString  key,
QString  value 
)

Adds extra metadata to the group.

Definition at line 1075 of file qgsmeshdataset.cpp.

◆ calculateStatistic()

void QgsMeshDatasetGroup::calculateStatistic ( )

Calculates the statistics (minimum and maximum)

Definition at line 976 of file qgsmeshdataset.cpp.

◆ checkValueCountPerDataset()

bool QgsMeshDatasetGroup::checkValueCountPerDataset ( int  count) const

Returns whether all the datasets contain count values.

Definition at line 1022 of file qgsmeshdataset.cpp.

◆ dataset()

virtual QgsMeshDataset* QgsMeshDatasetGroup::dataset ( int  index) const
pure virtual

◆ datasetCount()

virtual int QgsMeshDatasetGroup::datasetCount ( ) const
pure virtual

◆ datasetGroupNamesDependentOn()

QStringList QgsMeshDatasetGroup::datasetGroupNamesDependentOn ( ) const
virtual

Returns the dataset group variable name which this dataset group depends on.

Reimplemented in QgsMeshVirtualDatasetGroup.

Definition at line 986 of file qgsmeshdataset.cpp.

◆ datasetMetadata()

virtual QgsMeshDatasetMetadata QgsMeshDatasetGroup::datasetMetadata ( int  datasetIndex) const
pure virtual

Returns the metadata of the dataset with index datasetIndex.

Implemented in QgsMeshVirtualDatasetGroup, QgsMeshVerticesElevationDatasetGroup, QgsMeshMemoryDatasetGroup, and QgsMeshZValueDatasetGroup.

◆ dataType()

QgsMeshDatasetGroupMetadata::DataType QgsMeshDatasetGroup::dataType ( ) const

Returns the data type of the dataset group.

Definition at line 1065 of file qgsmeshdataset.cpp.

◆ description()

QString QgsMeshDatasetGroup::description ( ) const
virtual

Returns some information about the dataset group.

Reimplemented in QgsMeshVirtualDatasetGroup.

Definition at line 991 of file qgsmeshdataset.cpp.

◆ extraMetadata()

QMap< QString, QString > QgsMeshDatasetGroup::extraMetadata ( ) const

Returns all the extra metadata of the group.

Definition at line 1080 of file qgsmeshdataset.cpp.

◆ groupMetadata()

QgsMeshDatasetGroupMetadata QgsMeshDatasetGroup::groupMetadata ( ) const

Returns the metadata of the dataset group.

Definition at line 914 of file qgsmeshdataset.cpp.

◆ initialize()

virtual void QgsMeshDatasetGroup::initialize ( )
pure virtual

◆ isScalar()

bool QgsMeshDatasetGroup::isScalar ( ) const

Returns whether the group contain scalar values.

Definition at line 1085 of file qgsmeshdataset.cpp.

◆ maximum()

double QgsMeshDatasetGroup::maximum ( ) const

Returns the maximum value of the whole dataset group.

Definition at line 1043 of file qgsmeshdataset.cpp.

◆ minimum()

double QgsMeshDatasetGroup::minimum ( ) const

Returns the minimum value of the whole dataset group.

Definition at line 1037 of file qgsmeshdataset.cpp.

◆ name()

QString QgsMeshDatasetGroup::name ( ) const

Returns the name of the dataset group.

Definition at line 1055 of file qgsmeshdataset.cpp.

◆ setDataType()

void QgsMeshDatasetGroup::setDataType ( const QgsMeshDatasetGroupMetadata::DataType dataType)

Sets the data type of the dataset group.

Definition at line 1070 of file qgsmeshdataset.cpp.

◆ setIsScalar()

void QgsMeshDatasetGroup::setIsScalar ( bool  isScalar)

Sets whether the group contain scalar values.

Definition at line 1090 of file qgsmeshdataset.cpp.

◆ setMinimumMaximum()

void QgsMeshDatasetGroup::setMinimumMaximum ( double  min,
double  max 
)

Overrides the minimum and the maximum value of the whole dataset group.

Definition at line 1049 of file qgsmeshdataset.cpp.

◆ setName()

void QgsMeshDatasetGroup::setName ( const QString &  name)

Sets the name of the dataset group.

Definition at line 1060 of file qgsmeshdataset.cpp.

◆ setReferenceTime()

void QgsMeshDatasetGroup::setReferenceTime ( const QDateTime &  referenceTime)

Sets the reference time of the dataset group.

Definition at line 996 of file qgsmeshdataset.cpp.

◆ setStatisticObsolete()

void QgsMeshDatasetGroup::setStatisticObsolete ( )

Sets statistic obsolete, that means statistic will be recalculated when requested.

Definition at line 981 of file qgsmeshdataset.cpp.

◆ type()

virtual QgsMeshDatasetGroup::Type QgsMeshDatasetGroup::type ( ) const
pure virtual

◆ writeXml()

virtual QDomElement QgsMeshDatasetGroup::writeXml ( QDomDocument &  doc,
const QgsReadWriteContext context 
) const
pure virtual

Write dataset group information in a DOM element.

Implemented in QgsMeshVirtualDatasetGroup, QgsMeshMemoryDatasetGroup, QgsMeshZValueDatasetGroup, and QgsMeshVerticesElevationDatasetGroup.

Member Data Documentation

◆ mDataType

Definition at line 679 of file qgsmeshdataset.h.

◆ mIsScalar

bool QgsMeshDatasetGroup::mIsScalar = true
protected

Definition at line 681 of file qgsmeshdataset.h.

◆ mMetadata

QMap<QString, QString> QgsMeshDatasetGroup::mMetadata
protected

Definition at line 680 of file qgsmeshdataset.h.

◆ mName

QString QgsMeshDatasetGroup::mName
protected

Definition at line 677 of file qgsmeshdataset.h.


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