Class: QgsMeshLayerTemporalProperties

Implementation of map layer temporal properties for mesh layers.

The time in a mesh layer is defined by :

• a reference time provided by the data, the project or the user

• each dataset is associated with a relative times

• time extent is defined by the first time and the last time of all dataset

Reference time :          AT
Dataset 1 time            o-----RT------RT-----RT-----------RT
Dataset 2 time            o---------RT------RT--------RT
Dataset 3 time            o------------------------------RT-------RT----------RT
Time extent of layer      o-----<--------------------------------------------->

AT : absolute time (QDateTime)
RT : relative time (qint64)

Added in version 3.14.

Class Hierarchy

Base classes

QgsMapLayerTemporalProperties	Base class for storage of map layer temporal properties.
QgsTemporalProperty	Base class for temporal property.
QObject

Methods

alwaysLoadReferenceTimeFromSource	Returns whether the time proporties are automatically reloaded from provider when project is opened or layer is reloaded
isValid	Returns whether the instance is valid
matchingMethod	Returns the method used to match dataset from temporal capabilities
referenceTime	Returns the reference time
setAlwaysLoadReferenceTimeFromSource	Sets whether the time proporties are automatically reloaded from provider when project is opened or layer is reloaded
setIsValid	Sets whether the instance is valid
setMatchingMethod	Sets the method used to match dataset from temporal capabilities
setReferenceTime	Sets the reference time and update the time extent from the temporal capabilities, if the temporal capabilities is null, set a void time extent (reference time to reference time)
timeExtent	Returns the time extent

class qgis.core.QgsMeshLayerTemporalProperties

Bases: QgsMapLayerTemporalProperties

__init__(parent: QObject | None = None, enabled: bool = True)

Constructor for QgsMeshLayerTemporalProperties

Parameters:

• parent (Optional[QObject] = None) – pointer to the parent object

• enabled (bool = True) – argument specifies whether the temporal properties are initially enabled or not (see isActive()).

alwaysLoadReferenceTimeFromSource(self) → bool

Returns whether the time proporties are automatically reloaded from provider when project is opened or layer is reloaded

Added in version 3.28.

Return type:

bool

isValid(self) → bool

Returns whether the instance is valid

Added in version 3.22.

Return type:

bool

matchingMethod(self) → QgsMeshDataProviderTemporalCapabilities.MatchingTemporalDatasetMethod

Returns the method used to match dataset from temporal capabilities

Return type:

QgsMeshDataProviderTemporalCapabilities.MatchingTemporalDatasetMethod

referenceTime(self) → QDateTime

Returns the reference time

Return type:

QDateTime

setAlwaysLoadReferenceTimeFromSource(self, autoReloadFromProvider: bool)

Sets whether the time proporties are automatically reloaded from provider when project is opened or layer is reloaded

Parameters:

autoReloadFromProvider (bool) – whether the time proporties is automatically reloaded

Added in version 3.28.

setIsValid(self, isValid: bool)

Sets whether the instance is valid

Parameters:

isValid (bool) – whether the instance is valid

Added in version 3.22.

setMatchingMethod(self, matchingMethod: QgsMeshDataProviderTemporalCapabilities.MatchingTemporalDatasetMethod)

Sets the method used to match dataset from temporal capabilities

Parameters:

matchingMethod (QgsMeshDataProviderTemporalCapabilities.MatchingTemporalDatasetMethod) – the matching method

setReferenceTime(self, referenceTime: QDateTime | datetime.datetime, capabilities: QgsDataProviderTemporalCapabilities | None)

Sets the reference time and update the time extent from the temporal capabilities, if the temporal capabilities is null, set a void time extent (reference time to reference time)

Parameters:

• referenceTime (Union[QDateTime, datetime.datetime]) – the reference time

• capabilities (Optional[QgsDataProviderTemporalCapabilities]) – the temporal capabilities of the data provider

timeExtent(self) → QgsDateTimeRange

Returns the time extent

Return type:

QgsDateTimeRange