QGIS API Documentation 3.39.0-Master (132cbd6f1b5)
|
Abstract class that represents a dataset group. More...
#include <qgsmeshdataset.h>
Public Types | |
enum | Type { Unknown , Persistent , Memory , Virtual } |
Type of the dataset group. More... | |
Public Member Functions | |
QgsMeshDatasetGroup ()=default | |
QgsMeshDatasetGroup (const QString &name) | |
Constructor with the name of the dataset group. | |
QgsMeshDatasetGroup (const QString &name, QgsMeshDatasetGroupMetadata::DataType dataType) | |
Constructor with the name of the dataset group and the dataTYpe. | |
virtual | ~QgsMeshDatasetGroup () |
void | addExtraMetadata (QString key, QString value) |
Adds extra metadata to the group. | |
void | calculateStatistic () const |
Calculates the statistics (minimum and maximum) | |
bool | checkValueCountPerDataset (int count) const |
Returns whether all the datasets contain count values. | |
virtual QgsMeshDataset * | dataset (int index) const =0 |
Returns the dataset with index. | |
virtual int | datasetCount () const =0 |
Returns the count of datasets in the group. | |
virtual QStringList | datasetGroupNamesDependentOn () const |
Returns the dataset group variable name which this dataset group depends on. | |
virtual QgsMeshDatasetMetadata | datasetMetadata (int datasetIndex) const =0 |
Returns the metadata of the dataset with index datasetIndex. | |
QgsMeshDatasetGroupMetadata::DataType | dataType () const |
Returns the data type of the dataset group. | |
virtual QString | description () const |
Returns some information about the dataset group. | |
QMap< QString, QString > | extraMetadata () const |
Returns all the extra metadata of the group. | |
QgsMeshDatasetGroupMetadata | groupMetadata () const |
Returns the metadata of the dataset group. | |
virtual void | initialize ()=0 |
Initialize the dataset group. | |
bool | isScalar () const |
Returns whether the group contain scalar values. | |
double | maximum () const |
Returns the maximum value of the whole dataset group. | |
double | minimum () const |
Returns the minimum value of the whole dataset group. | |
QString | name () const |
Returns the name of the dataset group. | |
void | setDataType (const QgsMeshDatasetGroupMetadata::DataType &dataType) |
Sets the data type of the dataset group. | |
void | setIsScalar (bool isScalar) |
Sets whether the group contain scalar values. | |
void | setMinimumMaximum (double min, double max) const |
Overrides the minimum and the maximum value of the whole dataset group. | |
void | setName (const QString &name) |
Sets the name of the dataset group. | |
void | setReferenceTime (const QDateTime &referenceTime) |
Sets the reference time of the dataset group. | |
void | setStatisticObsolete () const |
Sets statistic obsolete, that means statistic will be recalculated when requested. | |
virtual QgsMeshDatasetGroup::Type | type () const =0 |
Returns the type of dataset group. | |
virtual QDomElement | writeXml (QDomDocument &doc, const QgsReadWriteContext &context) const =0 |
Write dataset group information in a DOM element. | |
Protected Attributes | |
QgsMeshDatasetGroupMetadata::DataType | mDataType = QgsMeshDatasetGroupMetadata::DataOnVertices |
bool | mIsScalar = true |
QMap< QString, QString > | mMetadata |
QString | mName |
Abstract class that represents a dataset group.
Definition at line 591 of file qgsmeshdataset.h.
Type of the dataset group.
Definition at line 600 of file qgsmeshdataset.h.
|
default |
|
virtualdefault |
QgsMeshDatasetGroup::QgsMeshDatasetGroup | ( | const QString & | name | ) |
Constructor with the name of the dataset group.
Definition at line 1051 of file qgsmeshdataset.cpp.
QgsMeshDatasetGroup::QgsMeshDatasetGroup | ( | const QString & | name, |
QgsMeshDatasetGroupMetadata::DataType | dataType | ||
) |
Constructor with the name of the dataset group and the dataTYpe.
Definition at line 1046 of file qgsmeshdataset.cpp.
void QgsMeshDatasetGroup::addExtraMetadata | ( | QString | key, |
QString | value | ||
) |
Adds extra metadata to the group.
Definition at line 1091 of file qgsmeshdataset.cpp.
void QgsMeshDatasetGroup::calculateStatistic | ( | ) | const |
Calculates the statistics (minimum and maximum)
Definition at line 992 of file qgsmeshdataset.cpp.
bool QgsMeshDatasetGroup::checkValueCountPerDataset | ( | int | count | ) | const |
Returns whether all the datasets contain count values.
Definition at line 1038 of file qgsmeshdataset.cpp.
|
pure virtual |
Returns the dataset with index.
Implemented in QgsMeshZValueDatasetGroup, QgsMeshMemoryDatasetGroup, QgsMeshVerticesElevationDatasetGroup, and QgsMeshVirtualDatasetGroup.
|
pure virtual |
Returns the count of datasets in the group.
Implemented in QgsMeshZValueDatasetGroup, QgsMeshMemoryDatasetGroup, QgsMeshVerticesElevationDatasetGroup, and QgsMeshVirtualDatasetGroup.
|
virtual |
Returns the dataset group variable name which this dataset group depends on.
Reimplemented in QgsMeshVirtualDatasetGroup.
Definition at line 1002 of file qgsmeshdataset.cpp.
|
pure virtual |
Returns the metadata of the dataset with index datasetIndex.
Implemented in QgsMeshZValueDatasetGroup, QgsMeshMemoryDatasetGroup, QgsMeshVerticesElevationDatasetGroup, and QgsMeshVirtualDatasetGroup.
QgsMeshDatasetGroupMetadata::DataType QgsMeshDatasetGroup::dataType | ( | ) | const |
Returns the data type of the dataset group.
Definition at line 1081 of file qgsmeshdataset.cpp.
|
virtual |
Returns some information about the dataset group.
Reimplemented in QgsMeshVirtualDatasetGroup.
Definition at line 1007 of file qgsmeshdataset.cpp.
QMap< QString, QString > QgsMeshDatasetGroup::extraMetadata | ( | ) | const |
Returns all the extra metadata of the group.
Definition at line 1096 of file qgsmeshdataset.cpp.
QgsMeshDatasetGroupMetadata QgsMeshDatasetGroup::groupMetadata | ( | ) | const |
Returns the metadata of the dataset group.
Definition at line 930 of file qgsmeshdataset.cpp.
|
pure virtual |
Initialize the dataset group.
Implemented in QgsMeshZValueDatasetGroup, QgsMeshMemoryDatasetGroup, QgsMeshVerticesElevationDatasetGroup, and QgsMeshVirtualDatasetGroup.
bool QgsMeshDatasetGroup::isScalar | ( | ) | const |
Returns whether the group contain scalar values.
Definition at line 1101 of file qgsmeshdataset.cpp.
double QgsMeshDatasetGroup::maximum | ( | ) | const |
Returns the maximum value of the whole dataset group.
Definition at line 1059 of file qgsmeshdataset.cpp.
double QgsMeshDatasetGroup::minimum | ( | ) | const |
Returns the minimum value of the whole dataset group.
Definition at line 1053 of file qgsmeshdataset.cpp.
QString QgsMeshDatasetGroup::name | ( | ) | const |
Returns the name of the dataset group.
Definition at line 1071 of file qgsmeshdataset.cpp.
void QgsMeshDatasetGroup::setDataType | ( | const QgsMeshDatasetGroupMetadata::DataType & | dataType | ) |
Sets the data type of the dataset group.
Definition at line 1086 of file qgsmeshdataset.cpp.
void QgsMeshDatasetGroup::setIsScalar | ( | bool | isScalar | ) |
Sets whether the group contain scalar values.
Definition at line 1106 of file qgsmeshdataset.cpp.
void QgsMeshDatasetGroup::setMinimumMaximum | ( | double | min, |
double | max | ||
) | const |
Overrides the minimum and the maximum value of the whole dataset group.
Definition at line 1065 of file qgsmeshdataset.cpp.
void QgsMeshDatasetGroup::setName | ( | const QString & | name | ) |
Sets the name of the dataset group.
Definition at line 1076 of file qgsmeshdataset.cpp.
void QgsMeshDatasetGroup::setReferenceTime | ( | const QDateTime & | referenceTime | ) |
Sets the reference time of the dataset group.
Definition at line 1012 of file qgsmeshdataset.cpp.
void QgsMeshDatasetGroup::setStatisticObsolete | ( | ) | const |
Sets statistic obsolete, that means statistic will be recalculated when requested.
Definition at line 997 of file qgsmeshdataset.cpp.
|
pure virtual |
Returns the type of dataset group.
Implemented in QgsMeshZValueDatasetGroup, QgsMeshMemoryDatasetGroup, QgsMeshVerticesElevationDatasetGroup, and QgsMeshVirtualDatasetGroup.
|
pure virtual |
Write dataset group information in a DOM element.
Implemented in QgsMeshVerticesElevationDatasetGroup, QgsMeshZValueDatasetGroup, QgsMeshMemoryDatasetGroup, and QgsMeshVirtualDatasetGroup.
|
protected |
Definition at line 691 of file qgsmeshdataset.h.
|
protected |
Definition at line 693 of file qgsmeshdataset.h.
|
protected |
Definition at line 692 of file qgsmeshdataset.h.
|
protected |
Definition at line 689 of file qgsmeshdataset.h.