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:

[legend]

Public Member Functions
	QgsMeshVerticesElevationDatasetGroup (QString name, QgsMesh *mesh)
	Constructor with a name and linked to mesh.

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.

QgsMeshDatasetGroup::Type	type () const override
	Returns the type of dataset group.

QDomElement	writeXml (QDomDocument &, const QgsReadWriteContext &) const override
	Write dataset group information in a 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.

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

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 812 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 1171 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 1193 of file qgsmeshdataset.cpp.

◆ datasetCount()

int QgsMeshVerticesElevationDatasetGroup::datasetCount ( ) const

overridevirtual

Returns the count of datasets in the group.

Implements QgsMeshDatasetGroup.

Definition at line 1191 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 1183 of file qgsmeshdataset.cpp.

◆ initialize()

void QgsMeshVerticesElevationDatasetGroup::initialize ( )

overridevirtual

Initialize the dataset group.

Implements QgsMeshDatasetGroup.

Definition at line 1178 of file qgsmeshdataset.cpp.

◆ type()

QgsMeshDatasetGroup::Type QgsMeshVerticesElevationDatasetGroup::type ( ) const

overridevirtual

Returns the type of dataset group.

Implements QgsMeshDatasetGroup.

Definition at line 1201 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 823 of file qgsmeshdataset.h.

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

/build/qgis-3.41.0+git20241110+fda2aa46e9a+99sid/src/core/mesh/qgsmeshdataset.h
/build/qgis-3.41.0+git20241110+fda2aa46e9a+99sid/src/core/mesh/qgsmeshdataset.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsMeshVerticesElevationDatasetGroup()

Member Function Documentation

◆ dataset()

◆ datasetCount()

◆ datasetMetadata()

◆ initialize()

◆ type()

◆ writeXml()