QGIS API Documentation  3.23.0-Master (eb871beae0)
Public Member Functions | List of all members
QgsMeshVerticesElevationDatasetGroup Class Reference

Class that represents a dataset group with elevation value of the vertices of a existing mesh that can be edited This dataset group contains only one dataset. More...

#include <qgsmeshdataset.h>

Inheritance diagram for QgsMeshVerticesElevationDatasetGroup:
Inheritance graph
[legend]

Public Member Functions

 QgsMeshVerticesElevationDatasetGroup (QString name, QgsMesh *mesh)
 Constructor with a name and linked to mesh. More...
 
QgsMeshDatasetdataset (int index) const override
 Returns the dataset with index. More...
 
int datasetCount () const override
 Returns the count of datasets in the group. More...
 
QgsMeshDatasetMetadata datasetMetadata (int datasetIndex) const override
 Returns the metadata of the dataset with index datasetIndex. More...
 
void initialize () override
 Initialize the dataset group. More...
 
QgsMeshDatasetGroup::Type type () const override
 Returns the type of dataset group. More...
 
QDomElement writeXml (QDomDocument &, const QgsReadWriteContext &) const override
 Write dataset group information in a DOM element. More...
 
- Public Member Functions inherited from QgsMeshDatasetGroup
 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 QStringList datasetGroupNamesDependentOn () const
 Returns the dataset group variable name which this dataset group depends on. 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...
 
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...
 

Additional Inherited Members

- Public Types inherited from QgsMeshDatasetGroup
enum  Type { None , 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
 

Detailed Description

Class that represents a dataset group with elevation value of the vertices of a existing mesh that can be edited This dataset group contains only one dataset.

Since
QGIS 3.22

Definition at line 800 of file qgsmeshdataset.h.

Constructor & Destructor Documentation

◆ QgsMeshVerticesElevationDatasetGroup()

QgsMeshVerticesElevationDatasetGroup::QgsMeshVerticesElevationDatasetGroup ( QString  name,
QgsMesh mesh 
)

Constructor with a name and linked to mesh.

Definition at line 1155 of file qgsmeshdataset.cpp.

Member Function Documentation

◆ dataset()

QgsMeshDataset * QgsMeshVerticesElevationDatasetGroup::dataset ( int  index) const
overridevirtual

Returns the dataset with index.

Implements QgsMeshDatasetGroup.

Definition at line 1177 of file qgsmeshdataset.cpp.

◆ datasetCount()

int QgsMeshVerticesElevationDatasetGroup::datasetCount ( ) const
overridevirtual

Returns the count of datasets in the group.

Implements QgsMeshDatasetGroup.

Definition at line 1175 of file qgsmeshdataset.cpp.

◆ datasetMetadata()

QgsMeshDatasetMetadata QgsMeshVerticesElevationDatasetGroup::datasetMetadata ( int  datasetIndex) const
overridevirtual

Returns the metadata of the dataset with index datasetIndex.

Implements QgsMeshDatasetGroup.

Definition at line 1167 of file qgsmeshdataset.cpp.

◆ initialize()

void QgsMeshVerticesElevationDatasetGroup::initialize ( )
overridevirtual

Initialize the dataset group.

Implements QgsMeshDatasetGroup.

Definition at line 1162 of file qgsmeshdataset.cpp.

◆ type()

QgsMeshDatasetGroup::Type QgsMeshVerticesElevationDatasetGroup::type ( ) const
overridevirtual

Returns the type of dataset group.

Implements QgsMeshDatasetGroup.

Definition at line 1185 of file qgsmeshdataset.cpp.

◆ writeXml()

QDomElement QgsMeshVerticesElevationDatasetGroup::writeXml ( QDomDocument &  doc,
const QgsReadWriteContext context 
) const
inlineoverridevirtual

Write dataset group information in a DOM element.

Implements QgsMeshDatasetGroup.

Definition at line 811 of file qgsmeshdataset.h.


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