QGIS API Documentation 3.34.0-Prizren (ffbdd678812)
|
Abstract class that represents a dataset group. More...
#include <qgsmeshdataset.h>
Public Types | |
enum | Type { None , Persistent , Memory , Virtual } |
Type of the dataset group. More... | |
Public Member Functions | |
QgsMeshDatasetGroup ()=default | |
Default constructor. | |
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 581 of file qgsmeshdataset.h.
Type of the dataset group.
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 590 of file qgsmeshdataset.h.
|
default |
Default constructor.
|
virtualdefault |
QgsMeshDatasetGroup::QgsMeshDatasetGroup | ( | const QString & | name | ) |
Constructor with the name of the dataset group.
Definition at line 1035 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 1030 of file qgsmeshdataset.cpp.
void QgsMeshDatasetGroup::addExtraMetadata | ( | QString | key, |
QString | value | ||
) |
Adds extra metadata to the group.
Definition at line 1075 of file qgsmeshdataset.cpp.
void QgsMeshDatasetGroup::calculateStatistic | ( | ) | const |
Calculates the statistics (minimum and maximum)
Definition at line 976 of file qgsmeshdataset.cpp.
bool QgsMeshDatasetGroup::checkValueCountPerDataset | ( | int | count | ) | const |
Returns whether all the datasets contain count values.
Definition at line 1022 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 986 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 1065 of file qgsmeshdataset.cpp.
|
virtual |
Returns some information about the dataset group.
Reimplemented in QgsMeshVirtualDatasetGroup.
Definition at line 991 of file qgsmeshdataset.cpp.
QMap< QString, QString > QgsMeshDatasetGroup::extraMetadata | ( | ) | const |
Returns all the extra metadata of the group.
Definition at line 1080 of file qgsmeshdataset.cpp.
QgsMeshDatasetGroupMetadata QgsMeshDatasetGroup::groupMetadata | ( | ) | const |
Returns the metadata of the dataset group.
Definition at line 914 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 1085 of file qgsmeshdataset.cpp.
double QgsMeshDatasetGroup::maximum | ( | ) | const |
Returns the maximum value of the whole dataset group.
Definition at line 1043 of file qgsmeshdataset.cpp.
double QgsMeshDatasetGroup::minimum | ( | ) | const |
Returns the minimum value of the whole dataset group.
Definition at line 1037 of file qgsmeshdataset.cpp.
QString QgsMeshDatasetGroup::name | ( | ) | const |
Returns the name of the dataset group.
Definition at line 1055 of file qgsmeshdataset.cpp.
void QgsMeshDatasetGroup::setDataType | ( | const QgsMeshDatasetGroupMetadata::DataType & | dataType | ) |
Sets the data type of the dataset group.
Definition at line 1070 of file qgsmeshdataset.cpp.
void QgsMeshDatasetGroup::setIsScalar | ( | bool | isScalar | ) |
Sets whether the group contain scalar values.
Definition at line 1090 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 1049 of file qgsmeshdataset.cpp.
void QgsMeshDatasetGroup::setName | ( | const QString & | name | ) |
Sets the name of the dataset group.
Definition at line 1060 of file qgsmeshdataset.cpp.
void QgsMeshDatasetGroup::setReferenceTime | ( | const QDateTime & | referenceTime | ) |
Sets the reference time of the dataset group.
Definition at line 996 of file qgsmeshdataset.cpp.
void QgsMeshDatasetGroup::setStatisticObsolete | ( | ) | const |
Sets statistic obsolete, that means statistic will be recalculated when requested.
Definition at line 981 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 682 of file qgsmeshdataset.h.
|
protected |
Definition at line 684 of file qgsmeshdataset.h.
|
protected |
Definition at line 683 of file qgsmeshdataset.h.
|
protected |
Definition at line 680 of file qgsmeshdataset.h.