Abstract class that represents a dataset group. More...

#include <qgsmeshdataset.h>

Inheritance diagram for QgsMeshDatasetGroup:

[legend]

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

Detailed Description

Abstract class that represents a dataset group.

Since: QGIS 3.16

Definition at line 591 of file qgsmeshdataset.h.

Member Enumeration Documentation

◆ Type

enum QgsMeshDatasetGroup::Type

Type of the dataset group.

Since: QGIS 3.16

Enumerator
Unknown	Generic type used for non typed dataset group.
Persistent	Dataset group store in a file.
Memory	Temporary dataset group in memory.
Virtual	Virtual Dataset group defined by a formula.

Definition at line 600 of file qgsmeshdataset.h.

Constructor & Destructor Documentation

◆ QgsMeshDatasetGroup() [1/3]

QgsMeshDatasetGroup::QgsMeshDatasetGroup ( )

default

◆ ~QgsMeshDatasetGroup()

QgsMeshDatasetGroup::~QgsMeshDatasetGroup ( )

virtualdefault

◆ QgsMeshDatasetGroup() [2/3]

QgsMeshDatasetGroup::QgsMeshDatasetGroup ( const QString & name )

Constructor with the name of the dataset group.

Definition at line 1051 of file qgsmeshdataset.cpp.

◆ QgsMeshDatasetGroup() [3/3]

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.

Member Function Documentation

◆ addExtraMetadata()

void QgsMeshDatasetGroup::addExtraMetadata	(	QString	key,
		QString	value
	)

Adds extra metadata to the group.

Definition at line 1091 of file qgsmeshdataset.cpp.

◆ calculateStatistic()

void QgsMeshDatasetGroup::calculateStatistic ( ) const

Calculates the statistics (minimum and maximum)

Definition at line 992 of file qgsmeshdataset.cpp.

◆ checkValueCountPerDataset()

bool QgsMeshDatasetGroup::checkValueCountPerDataset ( int count ) const

Returns whether all the datasets contain count values.

Definition at line 1038 of file qgsmeshdataset.cpp.

◆ dataset()

virtual QgsMeshDataset * QgsMeshDatasetGroup::dataset ( int index ) const

pure virtual

Returns the dataset with index.

Implemented in QgsMeshZValueDatasetGroup, QgsMeshMemoryDatasetGroup, QgsMeshVerticesElevationDatasetGroup, and QgsMeshVirtualDatasetGroup.

◆ datasetCount()

virtual int QgsMeshDatasetGroup::datasetCount ( ) const

pure virtual

Returns the count of datasets in the group.

Implemented in QgsMeshZValueDatasetGroup, QgsMeshMemoryDatasetGroup, QgsMeshVerticesElevationDatasetGroup, and QgsMeshVirtualDatasetGroup.

◆ datasetGroupNamesDependentOn()

QStringList QgsMeshDatasetGroup::datasetGroupNamesDependentOn ( ) const

virtual

Returns the dataset group variable name which this dataset group depends on.

Reimplemented in QgsMeshVirtualDatasetGroup.

Definition at line 1002 of file qgsmeshdataset.cpp.

◆ datasetMetadata()

virtual QgsMeshDatasetMetadata QgsMeshDatasetGroup::datasetMetadata ( int datasetIndex ) const

pure virtual

Returns the metadata of the dataset with index datasetIndex.

Implemented in QgsMeshZValueDatasetGroup, QgsMeshMemoryDatasetGroup, QgsMeshVerticesElevationDatasetGroup, and QgsMeshVirtualDatasetGroup.

◆ dataType()

QgsMeshDatasetGroupMetadata::DataType QgsMeshDatasetGroup::dataType ( ) const

Returns the data type of the dataset group.

Definition at line 1081 of file qgsmeshdataset.cpp.

◆ description()

QString QgsMeshDatasetGroup::description ( ) const

virtual

Returns some information about the dataset group.

Reimplemented in QgsMeshVirtualDatasetGroup.

Definition at line 1007 of file qgsmeshdataset.cpp.

◆ extraMetadata()

QMap< QString, QString > QgsMeshDatasetGroup::extraMetadata ( ) const

Returns all the extra metadata of the group.

Definition at line 1096 of file qgsmeshdataset.cpp.

◆ groupMetadata()

QgsMeshDatasetGroupMetadata QgsMeshDatasetGroup::groupMetadata ( ) const

Returns the metadata of the dataset group.

Definition at line 930 of file qgsmeshdataset.cpp.

◆ initialize()

virtual void QgsMeshDatasetGroup::initialize ( )

pure virtual

Initialize the dataset group.

Implemented in QgsMeshZValueDatasetGroup, QgsMeshMemoryDatasetGroup, QgsMeshVerticesElevationDatasetGroup, and QgsMeshVirtualDatasetGroup.

◆ isScalar()

bool QgsMeshDatasetGroup::isScalar ( ) const

Returns whether the group contain scalar values.

Definition at line 1101 of file qgsmeshdataset.cpp.

◆ maximum()

double QgsMeshDatasetGroup::maximum ( ) const

Returns the maximum value of the whole dataset group.

Definition at line 1059 of file qgsmeshdataset.cpp.

◆ minimum()

double QgsMeshDatasetGroup::minimum ( ) const

Returns the minimum value of the whole dataset group.

Definition at line 1053 of file qgsmeshdataset.cpp.

◆ name()

QString QgsMeshDatasetGroup::name ( ) const

Returns the name of the dataset group.

Definition at line 1071 of file qgsmeshdataset.cpp.

◆ setDataType()

void QgsMeshDatasetGroup::setDataType ( const QgsMeshDatasetGroupMetadata::DataType & dataType )

Sets the data type of the dataset group.

Definition at line 1086 of file qgsmeshdataset.cpp.

◆ setIsScalar()

void QgsMeshDatasetGroup::setIsScalar ( bool isScalar )

Sets whether the group contain scalar values.

Definition at line 1106 of file qgsmeshdataset.cpp.

◆ setMinimumMaximum()

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.

◆ setName()

void QgsMeshDatasetGroup::setName ( const QString & name )

Sets the name of the dataset group.

Definition at line 1076 of file qgsmeshdataset.cpp.

◆ setReferenceTime()

void QgsMeshDatasetGroup::setReferenceTime ( const QDateTime & referenceTime )

Sets the reference time of the dataset group.

Definition at line 1012 of file qgsmeshdataset.cpp.

◆ setStatisticObsolete()

void QgsMeshDatasetGroup::setStatisticObsolete ( ) const

Sets statistic obsolete, that means statistic will be recalculated when requested.

Definition at line 997 of file qgsmeshdataset.cpp.

◆ type()

virtual QgsMeshDatasetGroup::Type QgsMeshDatasetGroup::type ( ) const

pure virtual

Returns the type of dataset group.

Implemented in QgsMeshZValueDatasetGroup, QgsMeshMemoryDatasetGroup, QgsMeshVerticesElevationDatasetGroup, and QgsMeshVirtualDatasetGroup.

◆ writeXml()

virtual QDomElement QgsMeshDatasetGroup::writeXml	(	QDomDocument &	doc,
		const QgsReadWriteContext &	context
	)		const

pure virtual

Write dataset group information in a DOM element.

Implemented in QgsMeshVerticesElevationDatasetGroup, QgsMeshZValueDatasetGroup, QgsMeshMemoryDatasetGroup, and QgsMeshVirtualDatasetGroup.

Member Data Documentation

◆ mDataType

QgsMeshDatasetGroupMetadata::DataType QgsMeshDatasetGroup::mDataType = QgsMeshDatasetGroupMetadata::DataOnVertices

protected

Definition at line 691 of file qgsmeshdataset.h.

◆ mIsScalar

bool QgsMeshDatasetGroup::mIsScalar = true

protected

Definition at line 693 of file qgsmeshdataset.h.

◆ mMetadata

QMap<QString, QString> QgsMeshDatasetGroup::mMetadata

protected

Definition at line 692 of file qgsmeshdataset.h.

◆ mName

QString QgsMeshDatasetGroup::mName

protected

Definition at line 689 of file qgsmeshdataset.h.

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

/build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/core/mesh/qgsmeshdataset.h
/build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/core/mesh/qgsmeshdataset.cpp

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ Type

Constructor & Destructor Documentation

◆ QgsMeshDatasetGroup() [1/3]

◆ ~QgsMeshDatasetGroup()

◆ QgsMeshDatasetGroup() [2/3]

◆ QgsMeshDatasetGroup() [3/3]

Member Function Documentation

◆ addExtraMetadata()

◆ calculateStatistic()

◆ checkValueCountPerDataset()

◆ dataset()

◆ datasetCount()

◆ datasetGroupNamesDependentOn()

◆ datasetMetadata()

◆ dataType()

◆ description()

◆ extraMetadata()

◆ groupMetadata()

◆ initialize()

◆ isScalar()

◆ maximum()

◆ minimum()

◆ name()

◆ setDataType()

◆ setIsScalar()

◆ setMinimumMaximum()

◆ setName()

◆ setReferenceTime()

◆ setStatisticObsolete()

◆ type()

◆ writeXml()

Member Data Documentation

◆ mDataType

◆ mIsScalar

◆ mMetadata

◆ mName