Class: QgsMeshDatasetSourceInterface¶

Interface for mesh datasets and dataset groups.

Dataset is a collection of vector or scalar values on vertices or faces of the mesh. Based on the underlying data provider/format, whole dataset is either stored in memory or read on demand

Datasets are grouped in the dataset groups. A dataset group represents a measured quantity (e.g. depth or wind speed), dataset represents values of the quantity in a particular time.

Note

The API is considered EXPERIMENTAL and can be changed without a notice

Added in version 3.2.

Note

This is an abstract class, with methods which must be implemented by a subclass.

The following methods must be implemented: addDataset(), areFacesActive(), dataset3dValues(), datasetCount(), datasetGroupCount(), datasetGroupMetadata(), datasetMetadata(), datasetValue(), datasetValues(), extraDatasets(), isFaceActive(), persistDatasetGroup()

Class Hierarchy¶

Subclasses¶

QgsMeshDataProvider

Base class for providing data for QgsMeshLayer.

Abstract Methods

`addDataset`	Associate dataset with the mesh
`areFacesActive`	Returns whether the faces are active for particular dataset
`dataset3dValues`	Returns N vector/scalar values from the face index from the dataset for 3d stacked meshes
`datasetCount`	Returns number of datasets loaded in the group
`datasetGroupCount`	Returns number of datasets groups loaded
`datasetGroupMetadata`	Returns dataset group metadata
`datasetMetadata`	Returns dataset metadata
`datasetValue`	Returns vector/scalar value associated with the index from the dataset To read multiple continuous values, use `datasetValues()`
`datasetValues`	Returns N vector/scalar values from the index from the dataset
`extraDatasets`	Returns list of additional dataset file URIs added using `addDataset()` calls.
`isFaceActive`	Returns whether the face is active for particular dataset
`persistDatasetGroup`	Creates a new dataset group from a data and persists it into a destination path

Methods

`datasetIndexAtTime`	Returns the dataset index of the dataset in a specific dataset group at time from the reference time
`datasetIndexInTimeInterval`	Returns a list of dataset indexes of the dataset in a specific dataset group that are between time1 and time2 from the reference time

class qgis.core.QgsMeshDatasetSourceInterface[source]¶

Bases: object

abstract addDataset(self, uri: str | None) → bool[source]¶

Associate dataset with the mesh

emits dataChanged when successful

Parameters:: uri (Optional[str])
Return type:: bool

abstract areFacesActive(self, index: QgsMeshDatasetIndex, faceIndex: int, count: int) → QgsMeshDataBlock[source]¶

Returns whether the faces are active for particular dataset

Added in version 3.6.

Parameters:

index (QgsMeshDatasetIndex)
faceIndex (int)
count (int)

Return type:

QgsMeshDataBlock

abstract dataset3dValues(self, index: QgsMeshDatasetIndex, faceIndex: int, count: int) → QgsMesh3DDataBlock[source]¶

Returns N vector/scalar values from the face index from the dataset for 3d stacked meshes

See QgsMeshDatasetMetadata.isVector() to check if the returned value is vector or scalar

returns invalid block for DataOnFaces and DataOnVertices.