QGIS API Documentation 3.39.0-Master (699c004a5df)
|
Class that represents a dataset group stored in memory. More...
#include <qgsmeshdataset.h>
Public Member Functions | |
QgsMeshMemoryDatasetGroup ()=default | |
QgsMeshMemoryDatasetGroup (const QString &name) | |
Constructor with the name of the group. | |
QgsMeshMemoryDatasetGroup (const QString &name, QgsMeshDatasetGroupMetadata::DataType dataType) | |
Constructor with the name of the group and the type of data dataType. | |
void | addDataset (std::shared_ptr< QgsMeshMemoryDataset > dataset) |
Adds a memory dataset to the group. | |
void | clearDatasets () |
Removes all the datasets from the group. | |
std::shared_ptr< const QgsMeshMemoryDataset > | constDataset (int index) const |
Returns the dataset with index. | |
QgsMeshDataset * | dataset (int index) const override |
Returns the dataset with index. | |
int | datasetCount () const override |
Returns the count of datasets in the group. | |
QgsMeshDatasetMetadata | datasetMetadata (int datasetIndex) const override |
Returns the metadata of the dataset with index datasetIndex. | |
void | initialize () override |
Initialize the dataset group. | |
virtual QgsMeshDatasetGroup::Type | type () const override |
Returns the type of dataset group. | |
QDomElement | writeXml (QDomDocument &doc, const QgsReadWriteContext &context) const override |
Returns a invalid DOM element. | |
Public Member Functions inherited from QgsMeshDatasetGroup | |
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 QStringList | datasetGroupNamesDependentOn () const |
Returns the dataset group variable name which this dataset group depends on. | |
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. | |
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. | |
Public Attributes | |
QVector< std::shared_ptr< QgsMeshMemoryDataset > > | memoryDatasets |
Contains all the memory datasets. | |
Additional Inherited Members | |
Public Types inherited from QgsMeshDatasetGroup | |
enum | Type { Unknown , Persistent , Memory , Virtual } |
Type of the dataset group. More... | |
Protected Attributes inherited from QgsMeshDatasetGroup | |
QgsMeshDatasetGroupMetadata::DataType | mDataType = QgsMeshDatasetGroupMetadata::DataOnVertices |
bool | mIsScalar = true |
QMap< QString, QString > | mMetadata |
QString | mName |
Class that represents a dataset group stored in memory.
The QgsMeshMemoryDataset objects stores in a QVector container that are exposed for efficiency
Definition at line 749 of file qgsmeshdataset.h.
|
default |
QgsMeshMemoryDatasetGroup::QgsMeshMemoryDatasetGroup | ( | const QString & | name | ) |
Constructor with the name of the group.
Definition at line 925 of file qgsmeshdataset.cpp.
QgsMeshMemoryDatasetGroup::QgsMeshMemoryDatasetGroup | ( | const QString & | name, |
QgsMeshDatasetGroupMetadata::DataType | dataType | ||
) |
Constructor with the name of the group and the type of data dataType.
Definition at line 920 of file qgsmeshdataset.cpp.
void QgsMeshMemoryDatasetGroup::addDataset | ( | std::shared_ptr< QgsMeshMemoryDataset > | dataset | ) |
Adds a memory dataset to the group.
Definition at line 964 of file qgsmeshdataset.cpp.
void QgsMeshMemoryDatasetGroup::clearDatasets | ( | ) |
Removes all the datasets from the group.
Definition at line 970 of file qgsmeshdataset.cpp.
std::shared_ptr< const QgsMeshMemoryDataset > QgsMeshMemoryDatasetGroup::constDataset | ( | int | index | ) | const |
Returns the dataset with index.
Definition at line 980 of file qgsmeshdataset.cpp.
|
overridevirtual |
Returns the dataset with index.
Implements QgsMeshDatasetGroup.
Definition at line 959 of file qgsmeshdataset.cpp.
|
overridevirtual |
Returns the count of datasets in the group.
Implements QgsMeshDatasetGroup.
Definition at line 946 of file qgsmeshdataset.cpp.
|
overridevirtual |
Returns the metadata of the dataset with index datasetIndex.
Implements QgsMeshDatasetGroup.
Definition at line 951 of file qgsmeshdataset.cpp.
|
overridevirtual |
Initialize the dataset group.
Implements QgsMeshDatasetGroup.
Definition at line 975 of file qgsmeshdataset.cpp.
|
inlineoverridevirtual |
Returns the type of dataset group.
Implements QgsMeshDatasetGroup.
Definition at line 763 of file qgsmeshdataset.h.
|
overridevirtual |
Returns a invalid DOM element.
Implements QgsMeshDatasetGroup.
Definition at line 985 of file qgsmeshdataset.cpp.
QVector<std::shared_ptr<QgsMeshMemoryDataset> > QgsMeshMemoryDatasetGroup::memoryDatasets |
Contains all the memory datasets.
Definition at line 778 of file qgsmeshdataset.h.