Class: QgsMeshLayerTemporalProperties

class qgis.core.QgsMeshLayerTemporalProperties(parent: QObject = None, enabled: bool = True)

Bases: QgsMapLayerTemporalProperties

Constructor for QgsMeshLayerTemporalProperties

Parameters
  • parent (QObject = None) – pointer to the parent object

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

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)

Methods

childEvent

connectNotify

customEvent

disconnectNotify

isSignalConnected

matchingMethod

Returns the method used to match dataset from temporal capabilities

readXml

param element

receivers

referenceTime

Returns the reference time

sender

senderSignalIndex

setDefaultsFromDataProviderTemporalCapabilities

param capabilities

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

timerEvent

writeXml

param element

childEvent(self, QChildEvent)
connectNotify(self, QMetaMethod)
customEvent(self, QEvent)
disconnectNotify(self, QMetaMethod)
isSignalConnected(self, QMetaMethod) → bool
matchingMethod(self)QgsMeshDataProviderTemporalCapabilities.MatchingTemporalDatasetMethod

Returns the method used to match dataset from temporal capabilities

Return type

QgsMeshDataProviderTemporalCapabilities.MatchingTemporalDatasetMethod

readXml(self, element: QDomElement, context: QgsReadWriteContext) → bool
Parameters
Return type

bool

receivers(self, PYQT_SIGNAL) → int
referenceTime(self) → QDateTime

Returns the reference time

Return type

QDateTime

sender(self) → QObject
senderSignalIndex(self) → int
setDefaultsFromDataProviderTemporalCapabilities(self, capabilities: QgsDataProviderTemporalCapabilities)
Parameters

capabilities (QgsDataProviderTemporalCapabilities) –

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: Union[QDateTime, datetime.datetime], capabilities: QgsDataProviderTemporalCapabilities)

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
timeExtent(self)QgsDateTimeRange

Returns the time extent

Return type

QgsDateTimeRange

timerEvent(self, QTimerEvent)
writeXml(self, element: QDomElement, doc: QDomDocument, context: QgsReadWriteContext) → QDomElement
Parameters
Return type

QDomElement