QgsMeshDatasetGroupStore Class Reference

Class used to register and access all the dataset groups related to a mesh layer. More...

#include <qgsmeshdatasetgroupstore.h>

Inheritance diagram for QgsMeshDatasetGroupStore:

Signals
void	datasetGroupsAdded (QList< int > indexes)
	Emitted after dataset groups are added. More...

Public Member Functions
	QgsMeshDatasetGroupStore (QgsMeshLayer *layer)
	Constructor. More...
bool	addDatasetGroup (QgsMeshDatasetGroup *group)
	Adds a extra dataset group, take ownership, returns True if the group is effectivly added. More...
bool	addPersistentDatasets (const QString &path)
	Adds persistent datasets from a file with path. More...
QgsMeshDataBlock	areFacesActive (const QgsMeshDatasetIndex &index, int faceIndex, int count) const
	Returns whether faces are active for particular dataset. More...
QgsMesh3dDataBlock	dataset3dValues (const QgsMeshDatasetIndex &index, int faceIndex, int count) const
	Returns count 3D values of the dataset with global index and from valueIndex. More...
int	datasetCount (int groupIndex) const
	Returns the total count of dataset group in the store. More...
int	datasetGroupCount () const
	Returns the count of dataset groups. More...
QList< int >	datasetGroupIndexes () const
	Returns a list of all group indexes. More...
QgsMeshDatasetGroupMetadata	datasetGroupMetadata (const QgsMeshDatasetIndex &index) const
	Returns the metadata of the dataset group with global index. More...
QgsMeshDatasetGroupTreeItem *	datasetGroupTreeItem () const
	Returns a pointer to the root of the dataset groups tree item. More...
QgsMeshDatasetIndex	datasetIndexAtTime (qint64 time, int groupIndex, QgsMeshDataProviderTemporalCapabilities::MatchingTemporalDatasetMethod method) const
	Returns the global dataset index of the dataset int the dataset group with groupIndex, corresponding to the relative time and the check method. More...
QList< QgsMeshDatasetIndex >	datasetIndexInTimeInterval (qint64 time1, qint64 time2, int groupIndex) const
	Returns the global dataset index of the dataset int the dataset group with groupIndex, that is between relative times time1 and time2. More...
QgsMeshDatasetMetadata	datasetMetadata (const QgsMeshDatasetIndex &index) const
	Returns the metadata of the dataset with global index. More...
qint64	datasetRelativeTime (const QgsMeshDatasetIndex &index) const
	Returns the relative time of the dataset from the persistent provider reference time. More...
QgsMeshDatasetValue	datasetValue (const QgsMeshDatasetIndex &index, int valueIndex) const
	Returns the value of the dataset with global index and valueIndex. More...
QgsMeshDataBlock	datasetValues (const QgsMeshDatasetIndex &index, int valueIndex, int count) const
	Returns count values of the dataset with global index and from valueIndex. More...
QList< int >	enabledDatasetGroupIndexes () const
	Returns a list of all group indexes that are enabled. More...
int	extraDatasetGroupCount () const
	Returns the count of extra dataset groups. More...
int	globalDatasetGroupIndexInSource (QgsMeshDatasetSourceInterface *source, int nativeGroupIndex) const
	Returns the global dataset group index of the dataset group with native index nativeGroupIndex in the source Returns -1 if the group or the source is not registered. More...
bool	hasTemporalCapabilities () const
	Returns whether at lea&st one of stored dataset group is temporal. More...
bool	isFaceActive (const QgsMeshDatasetIndex &index, int faceIndex) const
	Returns whether face is active for particular dataset. More...
void	readXml (const QDomElement &storeElem, const QgsReadWriteContext &context)
	Reads the store's information from a DOM document. More...
void	resetDatasetGroupTreeItem ()
	Resets to default state the dataset groups tree item. More...
bool	saveDatasetGroup (QString filePath, int groupIndex, QString driver)
	Saves on a file with filePath the dataset groups index with groupIndex with the specified driver. More...
void	setDatasetGroupTreeItem (const QgsMeshDatasetGroupTreeItem *rootItem)
	Sets the root of the dataset groups tree item. More...
void	setPersistentProvider (QgsMeshDataProvider *provider, const QStringList &extraDatasetUri)
	Sets the persistent mesh data provider with the path of its extra dataset to be loaded by the provider. More...
QDomElement	writeXml (QDomDocument &doc, const QgsReadWriteContext &context)
	Writes the store's information in a DOM document. More...

Detailed Description

Class used to register and access all the dataset groups related to a mesh layer.

The registered dataset group are :

• the ones from the data provider of the mesh layer
• extra dataset group that can be added, for example by the mesh calculator

Every dataset group has a unique global index group that can be different from the native index group of the dataset group. This storing class has the repsonsability to assign this unique grlobal dataset group index and to link this dataset group index with the dataset group

All dataset values or information needed can be retrieved from a QgsMeshDatasetIndex with the group index corresponding to the global group index. The native group index is not exposed and global index can be obtained with datasetGroupIndexes() that returns the list of global index available. The dataset index is the same than in the native source (data provider or other dataset source)

This class also has the responsibility to handle the dataset group tree item that contain information to display the available dataset (

See also

QgsMeshDatasetGroupTreeItem)

Since

QGIS 3.16

Definition at line 119 of file qgsmeshdatasetgroupstore.h.

Constructor & Destructor Documentation

QgsMeshDatasetGroupStore()

QgsMeshDatasetGroupStore::QgsMeshDatasetGroupStore

(

QgsMeshLayer *

layer

)

Constructor.

Definition at line 45 of file qgsmeshdatasetgroupstore.cpp.

Member Function Documentation

addDatasetGroup()

bool QgsMeshDatasetGroupStore::addDatasetGroup

(

QgsMeshDatasetGroup *

group

)

Adds a extra dataset group, take ownership, returns True if the group is effectivly added.

If returns False, the ownership is not taken

Definition at line 91 of file qgsmeshdatasetgroupstore.cpp.

addPersistentDatasets()

bool QgsMeshDatasetGroupStore::addPersistentDatasets

(

const QString &

path

)

Adds persistent datasets from a file with path.

Definition at line 84 of file qgsmeshdatasetgroupstore.cpp.

areFacesActive()

QgsMeshDataBlock QgsMeshDatasetGroupStore::areFacesActive	(	const QgsMeshDatasetIndex &	index,
		int	faceIndex,
		int	count
	)		const

Returns whether faces are active for particular dataset.

Definition at line 209 of file qgsmeshdatasetgroupstore.cpp.

dataset3dValues()

QgsMesh3dDataBlock QgsMeshDatasetGroupStore::dataset3dValues	(	const QgsMeshDatasetIndex &	index,
		int	faceIndex,
		int	count
	)		const

Returns count 3D values of the dataset with global index and from valueIndex.

Definition at line 200 of file qgsmeshdatasetgroupstore.cpp.

datasetCount()

int QgsMeshDatasetGroupStore::datasetCount

(

int

groupIndex

)

const

Returns the total count of dataset group in the store.

Definition at line 164 of file qgsmeshdatasetgroupstore.cpp.

datasetGroupCount()

int QgsMeshDatasetGroupStore::datasetGroupCount

(

)

const

Returns the count of dataset groups.

Definition at line 35 of file qgsmeshdatasetgroupstore.cpp.

datasetGroupIndexes()

QList< int > QgsMeshDatasetGroupStore::datasetGroupIndexes

(

)

const

Returns a list of all group indexes.

Definition at line 25 of file qgsmeshdatasetgroupstore.cpp.

datasetGroupMetadata()

QgsMeshDatasetGroupMetadata QgsMeshDatasetGroupStore::datasetGroupMetadata

(

const QgsMeshDatasetIndex &

index

)

const

Returns the metadata of the dataset group with global index.

Definition at line 155 of file qgsmeshdatasetgroupstore.cpp.

datasetGroupsAdded

void QgsMeshDatasetGroupStore::datasetGroupsAdded ( QList< int >  indexes )

signal

Emitted after dataset groups are added.

datasetGroupTreeItem()

QgsMeshDatasetGroupTreeItem * QgsMeshDatasetGroupStore::datasetGroupTreeItem

(

)

const

Returns a pointer to the root of the dataset groups tree item.

Definition at line 140 of file qgsmeshdatasetgroupstore.cpp.

datasetIndexAtTime()

QgsMeshDatasetIndex QgsMeshDatasetGroupStore::datasetIndexAtTime	(	qint64	time,
		int	groupIndex,
		QgsMeshDataProviderTemporalCapabilities::MatchingTemporalDatasetMethod	method
	)		const

Returns the global dataset index of the dataset int the dataset group with groupIndex, corresponding to the relative time and the check method.

Definition at line 227 of file qgsmeshdatasetgroupstore.cpp.

datasetIndexInTimeInterval()

QList< QgsMeshDatasetIndex > QgsMeshDatasetGroupStore::datasetIndexInTimeInterval	(	qint64	time1,
		qint64	time2,
		int	groupIndex
	)		const

Returns the global dataset index of the dataset int the dataset group with groupIndex, that is between relative times time1 and time2.

Since QGIS 3.22

Definition at line 241 of file qgsmeshdatasetgroupstore.cpp.

datasetMetadata()

QgsMeshDatasetMetadata QgsMeshDatasetGroupStore::datasetMetadata

(

const QgsMeshDatasetIndex &

index

)

const

Returns the metadata of the dataset with global index.

Definition at line 173 of file qgsmeshdatasetgroupstore.cpp.

datasetRelativeTime()

qint64 QgsMeshDatasetGroupStore::datasetRelativeTime

(

const QgsMeshDatasetIndex &

index

)

const

Returns the relative time of the dataset from the persistent provider reference time.

Definition at line 263 of file qgsmeshdatasetgroupstore.cpp.

datasetValue()

QgsMeshDatasetValue QgsMeshDatasetGroupStore::datasetValue	(	const QgsMeshDatasetIndex &	index,
		int	valueIndex
	)		const

Returns the value of the dataset with global index and valueIndex.

Definition at line 182 of file qgsmeshdatasetgroupstore.cpp.

datasetValues()

QgsMeshDataBlock QgsMeshDatasetGroupStore::datasetValues	(	const QgsMeshDatasetIndex &	index,
		int	valueIndex,
		int	count
	)		const

Returns count values of the dataset with global index and from valueIndex.

Definition at line 191 of file qgsmeshdatasetgroupstore.cpp.

enabledDatasetGroupIndexes()

QList< int > QgsMeshDatasetGroupStore::enabledDatasetGroupIndexes

(

)

const

Returns a list of all group indexes that are enabled.

Since

QGIS 3.16.3

Definition at line 30 of file qgsmeshdatasetgroupstore.cpp.

extraDatasetGroupCount()

int QgsMeshDatasetGroupStore::extraDatasetGroupCount

(

)

const

Returns the count of extra dataset groups.

Definition at line 40 of file qgsmeshdatasetgroupstore.cpp.

globalDatasetGroupIndexInSource()

int QgsMeshDatasetGroupStore::globalDatasetGroupIndexInSource	(	QgsMeshDatasetSourceInterface *	source,
		int	nativeGroupIndex
	)		const

Returns the global dataset group index of the dataset group with native index nativeGroupIndex in the source Returns -1 if the group or the source is not registered.

Since QGIS 3.22

Definition at line 388 of file qgsmeshdatasetgroupstore.cpp.

hasTemporalCapabilities()

bool QgsMeshDatasetGroupStore::hasTemporalCapabilities

(

)

const

Returns whether at lea&st one of stored dataset group is temporal.

Definition at line 280 of file qgsmeshdatasetgroupstore.cpp.

isFaceActive()

bool QgsMeshDatasetGroupStore::isFaceActive	(	const QgsMeshDatasetIndex &	index,
		int	faceIndex
	)		const

Returns whether face is active for particular dataset.

Definition at line 218 of file qgsmeshdatasetgroupstore.cpp.

readXml()

void QgsMeshDatasetGroupStore::readXml	(	const QDomElement &	storeElem,
		const QgsReadWriteContext &	context
	)

Reads the store's information from a DOM document.

Definition at line 331 of file qgsmeshdatasetgroupstore.cpp.

resetDatasetGroupTreeItem()

void QgsMeshDatasetGroupStore::resetDatasetGroupTreeItem

(

)

Resets to default state the dataset groups tree item.

Definition at line 131 of file qgsmeshdatasetgroupstore.cpp.

saveDatasetGroup()

bool QgsMeshDatasetGroupStore::saveDatasetGroup	(	QString	filePath,
		int	groupIndex,
		QString	driver
	)

Saves on a file with filePath the dataset groups index with groupIndex with the specified driver.

Definition at line 399 of file qgsmeshdatasetgroupstore.cpp.

setDatasetGroupTreeItem()

void QgsMeshDatasetGroupStore::setDatasetGroupTreeItem

(

const QgsMeshDatasetGroupTreeItem *

rootItem

)

Sets the root of the dataset groups tree item.

The rootItem is cloned (ownership is not transferred).

Definition at line 145 of file qgsmeshdatasetgroupstore.cpp.

setPersistentProvider()

void QgsMeshDatasetGroupStore::setPersistentProvider	(	QgsMeshDataProvider *	provider,
		const QStringList &	extraDatasetUri
	)

Sets the persistent mesh data provider with the path of its extra dataset to be loaded by the provider.

Definition at line 51 of file qgsmeshdatasetgroupstore.cpp.

writeXml()

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

Writes the store's information in a DOM document.

Definition at line 286 of file qgsmeshdatasetgroupstore.cpp.

---

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

• /build/qgis-3.28.0+99sid/src/core/mesh/qgsmeshdatasetgroupstore.h
• /build/qgis-3.28.0+99sid/src/core/mesh/qgsmeshdatasetgroupstore.cpp