1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/mesh/qgsmeshdataprovidertemporalcapabilities.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsMeshDataProviderTemporalCapabilities: QgsDataProviderTemporalCapabilities
{
%Docstring(signature="appended")
Class for handling properties relating to a mesh data provider's
temporal capabilities.
.. versionadded:: 3.14
%End
%TypeHeaderCode
#include "qgsmeshdataprovidertemporalcapabilities.h"
%End
public:
enum MatchingTemporalDatasetMethod /BaseType=IntEnum/
{
FindClosestDatasetBeforeStartRangeTime,
FindClosestDatasetFromStartRangeTime
};
QgsMeshDataProviderTemporalCapabilities();
%Docstring
Constructor for QgsMeshDataProviderTemporalCapabilities
%End
QgsMeshDatasetIndex datasetIndexClosestBeforeRelativeTime( int group, qint64 timeSinceGlobalReference ) const;
%Docstring
Returns the last dataset with time less than or equal to
``timeSinceGlobalReference``
Returns invalid dataset index if ``timeSinceGlobalReference`` is outside
the time extent of the dataset group
.. note::
for non temporal dataset group, ``timeSinceGlobalReference`` is not used and the unique dataset is returned
%End
QgsMeshDatasetIndex datasetIndexClosestFromRelativeTime( int group, qint64 timeSinceGlobalReference ) const;
%Docstring
Returns the closest dataset index from the ``timeSinceGlobalReference``
Returns invalid dataset index if ``timeSinceGlobalReference`` is outside
the time extent of the dataset group
.. note::
for non temporal dataset group, ``timeSinceGlobalReference`` 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( Qgis::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
Qgis::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 all stored reference times and dataset times
%End
qint64 firstTimeStepDuration( int group ) const;
%Docstring
Returns the duration of the first time step of the dataset group with
index ``group``
The value is -1 if the dataset group is not present or if it contains
only one dataset (non temporal dataset)
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/mesh/qgsmeshdataprovidertemporalcapabilities.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
