[FEATURE][MESH] plug mesh layer to QGIS temporal framework (#35466)

[FEATURE] Use temporal controller for the mesh layer time handling.
qgis · Apr 3, 2020 · 75ddf3c · 75ddf3c
1 parent e7079fe
commit 75ddf3c
Show file tree

Hide file tree

Showing 85 changed files with 3,626 additions and 2,830 deletions.
diff --git a/python/core/auto_generated/mesh/qgsmeshdataprovider.sip.in b/python/core/auto_generated/mesh/qgsmeshdataprovider.sip.in
diff --git a/python/core/auto_generated/mesh/qgsmeshdataprovidertemporalcapabilities.sip.in b/python/core/auto_generated/mesh/qgsmeshdataprovidertemporalcapabilities.sip.in
@@ -0,0 +1,99 @@
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/core/mesh/qgsmeshdataprovidertemporalcapabilities.h              *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
+ ************************************************************************/
+
+
+
+
+
+class QgsMeshDataProviderTemporalCapabilities: QgsDataProviderTemporalCapabilities
+{
+%Docstring
+Class for handling properties relating to a mesh data provider's temporal capabilities.
+
+.. versionadded:: 3.14
+%End
+
+%TypeHeaderCode
+#include "qgsmeshdataprovidertemporalcapabilities.h"
+%End
+  public:
+
+    QgsMeshDataProviderTemporalCapabilities();
+%Docstring
+Constructor for QgsMeshDataProviderTemporalCapabilities
+%End
+
+    QgsMeshDatasetIndex datasetIndexFromRelativeTimeRange( int group, qint64 startTimeSinceGlobalReference, qint64 endTimeSinceGlobalReference ) const;
+%Docstring
+Returns the first dataset that are include in the range [``startTimeSinceGlobalReference``,``endTimeSinceGlobalReference``[ (in milliseconds)
+from the dataset ``group``. If no dataset is present in this range return the last dataset before this range if it not the last one
+of whole the dataset group
+
+Returns invalid dataset index if there is no data set in the range
+
+.. note::
+
+   for non temporal dataset group, the range is not used and the unique dataset is returned
+%End
+
+
+
+
+    bool hasReferenceTime() const;
+%Docstring
+Returns whether the reference time is set
+%End
+
+    QDateTime referenceTime() const;
+%Docstring
+Returns the reference time
+%End
+
+    QgsDateTimeRange timeExtent() const;
+%Docstring
+Returns the time extent using the internal reference time
+and the first and last times available from the all the dataset
+%End
+
+    QgsDateTimeRange timeExtent( const QDateTime &reference ) const;
+%Docstring
+Returns the time extent using an external ``reference`` date time
+and the first and last times available from the all the dataset
+%End
+
+    void setTemporalUnit( QgsUnitTypes::TemporalUnit temporalUnit );
+%Docstring
+Sets the temporal unit (``temporalUnit``) used to read data by the data provider
+
+Temporal units supported are milliseconds, seconds, minutes, hors, days and weeks
+%End
+
+    QgsUnitTypes::TemporalUnit temporalUnit() const;
+%Docstring
+Returns the temporal unit used to read data by the data provider
+%End
+
+    qint64 datasetTime( const QgsMeshDatasetIndex &index ) const;
+%Docstring
+Returns the relative time in milliseconds of the dataset
+%End
+
+    void clear();
+%Docstring
+Clears alls stored reference times and dataset times
+%End
+
+};
+
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/core/mesh/qgsmeshdataprovidertemporalcapabilities.h              *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
+ ************************************************************************/