Class: QgsMeshLayerTemporalProperties¶
- class qgis.core.QgsMeshLayerTemporalProperties¶
Bases:
QgsMapLayerTemporalProperties
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)
New in version 3.14.
QgsMeshLayerTemporalProperties(parent: QObject = None, enabled: bool = True) Constructor for QgsMeshLayerTemporalProperties
- Parameters:
parent – pointer to the parent object
enabled –
argument specifies whether the temporal properties are initially enabled or not (see
isActive()
).Methods
Returns whether the instance is valid
Returns the method used to match dataset from temporal capabilities
- param element:
Returns the reference time
- param capabilities:
Sets whether the instance is valid
Sets the method used to match dataset from temporal capabilities
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)
Returns the time extent
- param element:
- childEvent(self, QChildEvent)¶
- connectNotify(self, QMetaMethod)¶
- customEvent(self, QEvent)¶
- disconnectNotify(self, QMetaMethod)¶
- isSignalConnected(self, QMetaMethod) bool ¶
- isValid(self) bool ¶
Returns whether the instance is valid
New in version 3.22.
- Return type:
bool
- matchingMethod(self) QgsMeshDataProviderTemporalCapabilities.MatchingTemporalDatasetMethod ¶
Returns the method used to match dataset from temporal capabilities
- readXml(self, element: QDomElement, context: QgsReadWriteContext) bool ¶
- Parameters:
element (QDomElement) –
context (QgsReadWriteContext) –
- 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) –
- setIsValid(self, isValid: bool)¶
Sets whether the instance is valid
- Parameters:
isValid (bool) – whether the instance is valid
New 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)¶
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) – the reference time
capabilities (QgsDataProviderTemporalCapabilities) – the temporal capabilities of the data provider
- timeExtent(self) QgsDateTimeRange ¶
Returns the time extent
- Return type:
- timerEvent(self, QTimerEvent)¶
- writeXml(self, element: QDomElement, doc: QDomDocument, context: QgsReadWriteContext) QDomElement ¶
- Parameters:
element (QDomElement) –
doc (QDomDocument) –
context (QgsReadWriteContext) –
- Return type:
QDomElement