Class: QgsMeshDatasetMetadata

Represents mesh dataset metadata, such as whether the data is valid or the associated time.

Note

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

Added in version 3.2.

Methods

isValid

Returns whether dataset is valid

maximum

Returns maximum scalar value/vector magnitude present for the dataset

maximumVerticalLevelsCount

Returns maximum number of vertical levels for 3d stacked meshes

minimum

Returns minimum scalar value/vector magnitude present for the dataset

time

Returns the time value for this dataset

class qgis.core.QgsMeshDatasetMetadata[source]

Bases: object

__init__()

Constructs an empty metadata object

__init__(time: float, isValid: bool, minimum: float, maximum: float, maximumVerticalLevels: int)

Constructs a valid metadata object

Parameters:
  • time (float) – a time which this dataset represents in the dataset group

  • isValid (bool) – dataset is loadad and valid for fetching the data

  • minimum (float) – minimum value (magnitude for vectors) present among dataset values

  • maximum (float) – maximum value (magnitude for vectors) present among dataset values

  • maximumVerticalLevels (int) – maximum number of vertical levels for 3d stacked meshes, 0 for 2d meshes

__init__(a0: QgsMeshDatasetMetadata)
Parameters:

a0 (QgsMeshDatasetMetadata)

isValid(self) bool[source]

Returns whether dataset is valid

Return type:

bool

maximum(self) float[source]

Returns maximum scalar value/vector magnitude present for the dataset

Return type:

float

maximumVerticalLevelsCount(self) int[source]

Returns maximum number of vertical levels for 3d stacked meshes

Added in version 3.12.

Return type:

int

minimum(self) float[source]

Returns minimum scalar value/vector magnitude present for the dataset

Return type:

float

time(self) float[source]

Returns the time value for this dataset

Return type:

float