Class: QgsMeshDataProvider

Base class for providing data for QgsMeshLayer.

Responsible for reading native mesh data

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: QgsMeshDatasetSourceInterface.addDataset(), QgsMeshDatasetSourceInterface.areFacesActive(), close(), QgsDataProvider.crs(), QgsMeshDatasetSourceInterface.dataset3dValues(), QgsMeshDatasetSourceInterface.datasetCount(), QgsMeshDatasetSourceInterface.datasetGroupCount(), QgsMeshDatasetSourceInterface.datasetGroupMetadata(), QgsMeshDatasetSourceInterface.datasetMetadata(), QgsMeshDatasetSourceInterface.datasetValue(), QgsMeshDatasetSourceInterface.datasetValues(), QgsDataProvider.description(), QgsMeshDataSourceInterface.edgeCount(), QgsDataProvider.extent(), QgsMeshDatasetSourceInterface.extraDatasets(), QgsMeshDataSourceInterface.faceCount(), QgsMeshDatasetSourceInterface.isFaceActive(), QgsDataProvider.isValid(), QgsDataProvider.name(), QgsMeshDatasetSourceInterface.persistDatasetGroup(), QgsMeshDataSourceInterface.populateMesh(), removeDatasetGroup(), QgsMeshDataSourceInterface.saveMeshFrame(), QgsMeshDataSourceInterface.vertexCount()

Class Hierarchy

Base classes

QgsDataProvider	Abstract base class for spatial data provider implementations.
QObject
QgsMeshDataSourceInterface	Interface for mesh data sources.
QgsMeshDatasetSourceInterface	Interface for mesh datasets and dataset groups.

Abstract Methods

close	Closes the data provider and free every resources used
removeDatasetGroup	Remove dataset group from the mesh

Methods

setTemporalUnit

Sets the temporal unit of the provider and reload data if it changes.

Virtual Methods

In PyQGIS, only methods marked as virtual can be safely overridden in a Python subclass of QgsMeshDataProvider. See the FAQ for more details.

driverMetadata

Returns the mesh driver metadata of the provider

Signals

datasetGroupsAdded

Emitted when some new dataset groups have been added

class qgis.core.QgsMeshDataProvider

Bases: QgsDataProvider, QgsMeshDataSourceInterface, QgsMeshDatasetSourceInterface

__init__(uri: str | None, providerOptions: QgsDataProvider.ProviderOptions, a2: Qgis.DataProviderReadFlags | Qgis.DataProviderReadFlag = Qgis.DataProviderReadFlags())

Ctor

Parameters:

• uri (Optional[str])

• providerOptions (QgsDataProvider.ProviderOptions)

• a2 (Union[Qgis.DataProviderReadFlags, Qgis.DataProviderReadFlag] = Qgis.DataProviderReadFlags())

abstract close(self)

Closes the data provider and free every resources used

Added in version 3.22.

signal datasetGroupsAdded(count: int)

Emitted when some new dataset groups have been added

Parameters:

count (int)

virtual driverMetadata(self) → QgsMeshDriverMetadata

Returns the mesh driver metadata of the provider

Return type:

QgsMeshDriverMetadata

Returns:

the mesh driver metadata of the provider

Added in version 3.22.

abstract removeDatasetGroup(self, index: int) → bool

Remove dataset group from the mesh

emits dataChanged when successful

Return type:

bool

Returns:

True on success

Added in version 3.42.

Parameters:

index (int)

setTemporalUnit(self, unit: Qgis.TemporalUnit)

Sets the temporal unit of the provider and reload data if it changes.

Parameters:

unit (Qgis.TemporalUnit) – the temporal unit

Added in version 3.14.