Class: QgsMeshDatasetGroup

class qgis.core.QgsMeshDatasetGroup

Bases: sip.wrapper

Default constructor

QgsMeshDatasetGroup(name: str) Constructor with the name of the dataset group

QgsMeshDatasetGroup(name: str, dataType: QgsMeshDatasetGroupMetadata.DataType) Constructor with the name of the dataset group and the dataTYpe

QgsMeshDatasetGroup(QgsMeshDatasetGroup)

Abstract class that represents a dataset group

Methods

addExtraMetadata

Adds extra metadata to the group

calculateStatistic

Calculates the statictics (minimum and maximum)

checkValueCountPerDataset

Returns whether all the datasets contain count values

dataType

Returns the data type of the dataset group

dataset

Returns the dataset with index

datasetCount

Returns the count of datasets in the group

datasetGroupNamesDependentOn

Returns the dataset group variable name which this dataset group depends on

datasetMetadata

Returns the metadata of the dataset with index datasetIndex

description

Returns some information about the dataset group

extraMetadata

Returns all the extra metadata of the group

groupMetadata

Returns the metadata of the dataset group

initialize

Initialize the dataset group

isScalar

Returns whether the group contain scalar values

maximum

Returns the maximum value of the whole dataset group

minimum

Returns the minimum value of the whole dataset group

name

Returns the name of the dataset group

setDataType

Sets the data type of the dataset group

setIsScalar

Sets whether the group contain scalar values

setMinimumMaximum

Overrides the minimum and the maximum value of the whole dataset group

setName

Sets the name of the dataset group

setReferenceTime

Sets the reference time of the dataset group

type

Returns the type of dataset group

writeXml

Write dataset group information in a DOM element

Attributes

Memory

None

Persistent

Virtual

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 statictics (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

QgsMeshDatasetGroupMetadata.DataType

dataset(self, index: int)QgsMeshDataset

Returns the dataset with index

Parameters

index (int) –

Return type

QgsMeshDataset

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

QgsMeshDatasetMetadata

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

QgsMeshDatasetGroupMetadata

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) –

type(self)QgsMeshDatasetGroup.Type

Returns the type of dataset group

Return type

QgsMeshDatasetGroup.Type

writeXml(self, doc: QDomDocument, context: QgsReadWriteContext) → QDomElement

Write dataset group information in a DOM element

Parameters
Return type

QDomElement