Class: QgsMeshDatasetMetadata

class qgis.core.QgsMeshDatasetMetadata

Bases: sip.wrapper

QgsMeshDatasetMetadata is a collection of mesh dataset metadata such as whether the data is valid or associated time for the dataset

Note

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

New in version 3.2.

QgsMeshDatasetMetadata() Constructs an empty metadata object

QgsMeshDatasetMetadata(time: float, isValid: bool, minimum: float, maximum: float, maximumVerticalLevels: int) Constructs a valid metadata object

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

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

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

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

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

QgsMeshDatasetMetadata(QgsMeshDatasetMetadata)

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

isValid(self) bool

Returns whether dataset is valid

Return type:

bool

maximum(self) float

Returns maximum scalar value/vector magnitude present for the dataset

Return type:

float

maximumVerticalLevelsCount(self) int

Returns maximum number of vertical levels for 3d stacked meshes

New in version 3.12.

Return type:

int

minimum(self) float

Returns minimum scalar value/vector magnitude present for the dataset

Return type:

float

time(self) float

Returns the time value for this dataset

Return type:

float