Class: QgsMeshDatasetGroup¶
- class qgis.core.QgsMeshDatasetGroup¶
Bases:
sip.wrapper
Abstract class that represents a dataset group
New in version 3.16.
QgsMeshDatasetGroup() Default constructor
QgsMeshDatasetGroup(name: str) Constructor with the
name
of the dataset groupQgsMeshDatasetGroup(name: str, dataType: QgsMeshDatasetGroupMetadata.DataType) Constructor with the
name
of the dataset group and thedataTYpe
QgsMeshDatasetGroup(
QgsMeshDatasetGroup
)Methods
Adds extra metadata to the group
Calculates the statistics (minimum and maximum)
Returns whether all the datasets contain
count
valuesReturns the data type of the dataset group
Returns the dataset with
index
Returns the count of datasets in the group
Returns the dataset group variable name which this dataset group depends on
Returns the metadata of the dataset with index
datasetIndex
Returns some information about the dataset group
Returns all the extra metadata of the group
Returns the metadata of the dataset group
Initialize the dataset group
Returns whether the group contain scalar values
Returns the maximum value of the whole dataset group
Returns the minimum value of the whole dataset group
Returns the name of the dataset group
Sets the data type of the dataset group
Sets whether the group contain scalar values
Overrides the minimum and the maximum value of the whole dataset group
Sets the name of the dataset group
Sets the reference time of the dataset group
Sets statistic obsolete, that means statistic will be recalculated when requested
Returns the type of dataset group
Write dataset group information in a DOM element
Attributes
- Memory = 2¶
- None = 0¶
- Persistent = 1¶
- class Type¶
Bases:
int
- Virtual = 3¶
- addExtraMetadata(self, key: str, value: str)¶
Adds extra metadata to the group
- Parameters
key (str) –
value (str) –
- calculateStatistic(self)¶
Calculates the statistics (minimum and maximum)
- checkValueCountPerDataset(self, count: int) bool ¶
Returns whether all the datasets contain
count
values- Parameters
count (int) –
- Return type
bool
- dataType(self) QgsMeshDatasetGroupMetadata.DataType ¶
Returns the data type of the dataset group
- Return type
- dataset(self, index: int) QgsMeshDataset ¶
Returns the dataset with
index
- Parameters
index (int) –
- Return type
- datasetCount(self) int ¶
Returns the count of datasets in the group
- Return type
int
- datasetGroupNamesDependentOn(self) List[str] ¶
Returns the dataset group variable name which this dataset group depends on
- Return type
List[str]
- datasetMetadata(self, datasetIndex: int) QgsMeshDatasetMetadata ¶
Returns the metadata of the dataset with index
datasetIndex
- Parameters
datasetIndex (int) –
- Return type
- description(self) str ¶
Returns some information about the dataset group
- Return type
str
- extraMetadata(self) Dict[str, str] ¶
Returns all the extra metadata of the group
- Return type
Dict[str, str]
- groupMetadata(self) QgsMeshDatasetGroupMetadata ¶
Returns the metadata of the dataset group
- Return type
- initialize(self)¶
Initialize the dataset group
- isScalar(self) bool ¶
Returns whether the group contain scalar values
- Return type
bool
- maximum(self) float ¶
Returns the maximum value of the whole dataset group
- Return type
float
- minimum(self) float ¶
Returns the minimum value of the whole dataset group
- Return type
float
- name(self) str ¶
Returns the name of the dataset group
- Return type
str
- setDataType(self, dataType: QgsMeshDatasetGroupMetadata.DataType)¶
Sets the data type of the dataset group
- Parameters
dataType (QgsMeshDatasetGroupMetadata.DataType) –
- setIsScalar(self, isScalar: bool)¶
Sets whether the group contain scalar values
- Parameters
isScalar (bool) –
- setMinimumMaximum(self, min: float, max: float)¶
Overrides the minimum and the maximum value of the whole dataset group
- Parameters
min (float) –
max (float) –
- setName(self, name: str)¶
Sets the name of the dataset group
- Parameters
name (str) –
- setReferenceTime(self, referenceTime: Union[QDateTime, datetime.datetime])¶
Sets the reference time of the dataset group
- Parameters
referenceTime (Union[QDateTime) –
- setStatisticObsolete(self)¶
Sets statistic obsolete, that means statistic will be recalculated when requested
- type(self) QgsMeshDatasetGroup.Type ¶
Returns the type of dataset group
- Return type
- writeXml(self, doc: QDomDocument, context: QgsReadWriteContext) QDomElement ¶
Write dataset group information in a DOM element
- Parameters
doc (QDomDocument) –
context (QgsReadWriteContext) –
- Return type
QDomElement