Class: QgsMeshDatasetGroupMetadata¶
A collection of dataset group metadata such as whether the data is vector or scalar, name.
Note
The API is considered EXPERIMENTAL and can be changed without a notice
Added in version 3.4.
Methods
Returns whether dataset group data is defined on vertices or faces or volumes |
|
Returns extra metadata options, for example description |
|
Returns whether dataset group has scalar data |
|
Returns whether the dataset group is temporal (contains time-related dataset) |
|
Returns whether dataset group has vector data |
|
Returns maximum scalar value/vector magnitude present for whole dataset group |
|
Returns maximum number of vertical levels for 3d stacked meshes |
|
Returns minimum scalar value/vector magnitude present for whole dataset group |
|
Returns name of the dataset group |
|
Returns the name of the dataset's parent quantity, if available. |
|
Returns the reference time |
|
Returns the uri of the source |
Attributes
- class qgis.core.QgsMeshDatasetGroupMetadata[source]¶
Bases:
object
- __init__()
Constructs an empty metadata object
- __init__(name: str | None, uri: str | None, isScalar: bool, dataType: QgsMeshDatasetGroupMetadata.DataType, minimum: float, maximum: float, maximumVerticalLevels: int, referenceTime: QDateTime | datetime.datetime, isTemporal: bool, extraOptions: Dict[str | None, str | None])
Constructs a valid metadata object
- Parameters:
name (Optional[str]) – name of the dataset group
isScalar (bool) – dataset contains scalar data, specifically the y-value of
QgsMeshDatasetValue
is NaNdataType (QgsMeshDatasetGroupMetadata.DataType) – where the data are defined on (vertices, faces or volumes)
minimum (float) – minimum value (magnitude for vectors) present among all group’s dataset values
maximum (float) – maximum value (magnitude for vectors) present among all group’s dataset values
maximumVerticalLevels (int) – maximum number of vertical levels for 3d stacked meshes, 0 for 2d meshes
referenceTime (Union[QDateTime, datetime.datetime]) – reference time of the dataset group
isTemporal (bool) – weither the dataset group is temporal (contains time-related dataset)
extraOptions (Dict[Optional[str], Optional[str]]) – dataset’s extra options stored by the provider. Usually contains the name, time value, time units, data file vendor, …
uri (Optional[str]) – The uri of the dataset
- __init__(a0: QgsMeshDatasetGroupMetadata)
- Parameters:
- DataOnEdges = 3¶
- DataOnFaces = 0¶
- DataOnVertices = 1¶
- DataOnVolumes = 2¶
- class DataType¶
Bases:
int
- dataType(self) QgsMeshDatasetGroupMetadata.DataType [source]¶
Returns whether dataset group data is defined on vertices or faces or volumes
Added in version 3.12.
- Return type:
- extraOptions(self) Dict[str, str] ¶
Returns extra metadata options, for example description
- Return type:
Dict[str, str]
- isTemporal(self) bool [source]¶
Returns whether the dataset group is temporal (contains time-related dataset)
- Return type:
bool
- maximum(self) float [source]¶
Returns maximum scalar value/vector magnitude present for whole dataset group
- 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 whole dataset group
- Return type:
float
- parentQuantityName(self) str [source]¶
Returns the name of the dataset’s parent quantity, if available.
The quantity can be used to collect dataset groups which represent a single quantity but at different values (e.g. groups which represent different elevations).
Added in version 3.38.
- Return type:
str