Class: QgsMeshDatasetGroupMetadata¶
- class qgis.core.QgsMeshDatasetGroupMetadata¶
Bases:
sip.wrapper
Constructs an empty metadata object
QgsMeshDatasetGroupMetadata(name: str, uri: str, isScalar: bool, dataType: QgsMeshDatasetGroupMetadata.DataType, minimum: float, maximum: float, maximumVerticalLevels: int, referenceTime: Union[QDateTime, datetime.datetime], isTemporal: bool, extraOptions: Dict[str, str]) Constructs a valid metadata object
- Parameters
name – name of the dataset group
isScalar – dataset contains scalar data, specifically the y-value of
QgsMeshDatasetValue
is NaNdataType – where the data are defined on (vertices, faces or volumes)
minimum – minimum value (magnitude for vectors) present among all group’s dataset values
maximum – maximum value (magnitude for vectors) present among all group’s dataset values
maximumVerticalLevels – maximum number of vertical levels for 3d stacked meshes, 0 for 2d meshes
referenceTime – reference time of the dataset group
isTemporal – weither the dataset group is temporal (contains time-related dataset)
extraOptions – dataset’s extra options stored by the provider. Usually contains the name, time value, time units, data file vendor, …
QgsMeshDatasetGroupMetadata(
QgsMeshDatasetGroupMetadata
)QgsMeshDatasetGroupMetadata
is a collection of dataset group metadata such as whether the data is vector or scalar, nameNote
The API is considered EXPERIMENTAL and can be changed without a notice
New 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 reference time
Returns the uri of the source
Attributes
- DataOnEdges = 3¶
- DataOnFaces = 0¶
- DataOnVertices = 1¶
- DataOnVolumes = 2¶
- class DataType¶
Bases:
int
- dataType(self) QgsMeshDatasetGroupMetadata.DataType ¶
Returns whether dataset group data is defined on vertices or faces or volumes
New in version 3.12.
- Return type
- extraOptions(self) Dict[str, str] ¶
Returns extra metadata options, for example description
- Return type
Dict[str, str]
- isScalar(self) bool ¶
Returns whether dataset group has scalar data
- Return type
bool
- isTemporal(self) bool ¶
Returns whether the dataset group is temporal (contains time-related dataset)
- Return type
bool
- isVector(self) bool ¶
Returns whether dataset group has vector data
- Return type
bool
- maximum(self) float ¶
Returns maximum scalar value/vector magnitude present for whole dataset group
- 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 whole dataset group
- Return type
float
- name(self) str ¶
Returns name of the dataset group
- Return type
str
- referenceTime(self) QDateTime ¶
Returns the reference time
New in version 3.12.
- Return type
QDateTime
- uri(self) str ¶
Returns the uri of the source
New in version 3.16.
- Return type
str