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.

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

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

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.