Class: QgsMeshDriverMetadata

Holds metadata about mesh drivers.

Added in version 3.12.

Methods

capabilities

Returns the capabilities for this driver.

description

Returns the description for this driver.

maximumVerticesCountPerFace

Returns the maximum number of vertices per face supported by the driver

name

Returns the name (key) for this driver.

writeDatasetOnFileSuffix

Returns the suffix used to write datasets on file

writeMeshFrameOnFileSuffix

Returns the suffix used to write mesh on file

Attributes

CanWriteEdgeDatasets

CanWriteFaceDatasets

CanWriteMeshData

CanWriteVertexDatasets

class qgis.core.QgsMeshDriverMetadata[source]

Bases: object

__init__()

Constructs default metadata without any capabilities

__init__(name: str | None, description: str | None, capabilities: QgsMeshDriverMetadata.MeshDriverCapabilities | QgsMeshDriverMetadata.MeshDriverCapability, writeDatasetOnFileSuffix: str | None)

Constructs driver metadata with selected capabilities

Parameters:

Deprecated since version 3.22.

__init__(name: str | None, description: str | None, capabilities: QgsMeshDriverMetadata.MeshDriverCapabilities | QgsMeshDriverMetadata.MeshDriverCapability, writeDatasetOnFileSuffix: str | None, writeMeshFrameOnFileSuffix: str | None, maxVerticesPerface: int)

Constructs driver metadata with selected capabilities

Parameters:
  • name (Optional[str]) – name/key of the driver

  • description (Optional[str]) – short description of the driver

  • capabilities (Union[QgsMeshDriverMetadata.MeshDriverCapabilities, QgsMeshDriverMetadata.MeshDriverCapability]) – driver’s capabilities

  • writeDatasetOnFileSuffix (Optional[str]) – suffix used to write datasets on file

  • writeMeshFrameOnFileSuffix (Optional[str]) – suffix used to write mesh frame on file

  • maxVerticesPerface (int) – maximum vertices count per face supported by the driver

Added in version 3.22.

__init__(a0: QgsMeshDriverMetadata)
Parameters:

a0 (QgsMeshDriverMetadata)

CanWriteEdgeDatasets = 4
CanWriteFaceDatasets = 1
CanWriteMeshData = 8
CanWriteVertexDatasets = 2
class MeshDriverCapabilities
class MeshDriverCapabilities(f: QgsMeshDriverMetadata.MeshDriverCapabilities | QgsMeshDriverMetadata.MeshDriverCapability)
class MeshDriverCapabilities(a0: QgsMeshDriverMetadata.MeshDriverCapabilities)

Bases: object

class MeshDriverCapability

Bases: int

capabilities(self) QgsMeshDriverMetadata.MeshDriverCapabilities[source]

Returns the capabilities for this driver.

Return type:

QgsMeshDriverMetadata.MeshDriverCapabilities

description(self) str[source]

Returns the description for this driver.

Return type:

str

maximumVerticesCountPerFace(self) int[source]

Returns the maximum number of vertices per face supported by the driver

Added in version 3.22.

Return type:

int

name(self) str[source]

Returns the name (key) for this driver.

Return type:

str

writeDatasetOnFileSuffix(self) str[source]

Returns the suffix used to write datasets on file

Return type:

str

writeMeshFrameOnFileSuffix(self) str[source]

Returns the suffix used to write mesh on file

Added in version 3.22.

Return type:

str