File: qgsrasterdataprovidertemporalcapabilities.sip.in

package info (click to toggle)
qgis 3.40.11%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,183,800 kB
  • sloc: cpp: 1,595,841; python: 372,637; xml: 23,474; sh: 3,761; perl: 3,664; ansic: 2,257; sql: 2,137; yacc: 1,068; lex: 577; javascript: 540; lisp: 411; makefile: 154
file content (173 lines) | stat: -rw-r--r-- 5,419 bytes parent folder | download | duplicates (14)
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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/raster/qgsrasterdataprovidertemporalcapabilities.h          *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/




class QgsRasterDataProviderTemporalCapabilities : QgsDataProviderTemporalCapabilities
{
%Docstring(signature="appended")
Implementation of data provider temporal properties for
:py:class:`QgsRasterDataProviders`.

Data provider temporal capabilities reflect the temporal capabilities of
a :py:class:`QgsDataProvider`. Unlike
:py:class:`QgsMapLayerTemporalProperties`, these settings are not
user-configurable, and should only be set by the
:py:class:`QgsDataProvider` itself.

.. versionadded:: 3.14
%End

%TypeHeaderCode
#include "qgsrasterdataprovidertemporalcapabilities.h"
%End
  public:

    QgsRasterDataProviderTemporalCapabilities( bool enabled = false );
%Docstring
Constructor for :py:class:`QgsRasterDataProviderTemporalProperties`.

The ``enabled`` argument specifies whether the data provider has
temporal capabilities.
%End

    Qgis::RasterTemporalCapabilityFlags flags() const;
%Docstring
Returns the capability flags for the provider.

.. versionadded:: 3.28
%End

    void setFlags( Qgis::RasterTemporalCapabilityFlags flags );
%Docstring
Sets the capability flags for the provider.

.. versionadded:: 3.28
%End

    Qgis::TemporalIntervalMatchMethod intervalHandlingMethod() const;
%Docstring
Returns the desired method to use when resolving a temporal interval to
matching layers or bands in the data provider.

.. seealso:: :py:func:`setIntervalHandlingMethod`
%End

    void setIntervalHandlingMethod( Qgis::TemporalIntervalMatchMethod method );
%Docstring
Sets the desired ``method`` to use when resolving a temporal interval to
matching layers or bands in the data provider.

.. seealso:: :py:func:`intervalHandlingMethod`
%End

    void setAvailableTemporalRange( const QgsDateTimeRange &range );
%Docstring
Sets the overall datetime ``range`` extent from which temporal data is
available from the provider.

.. seealso:: :py:func:`availableTemporalRange`
%End

    const QgsDateTimeRange &availableTemporalRange() const;
%Docstring
Returns the overall datetime range extent from which temporal data is
available from the provider.

.. seealso:: :py:func:`setAvailableTemporalRange`
%End

    void setAllAvailableTemporalRanges( const QList< QgsDateTimeRange > &ranges );
%Docstring
Sets a list of all valid datetime ``ranges`` for which temporal data is
available from the provider.

As opposed to
:py:func:`~QgsRasterDataProviderTemporalCapabilities.setAvailableTemporalRange`,
this method is useful when a provider contains a set of non-contiguous
datetime ranges.

.. seealso:: :py:func:`allAvailableTemporalRanges`

.. seealso:: :py:func:`setAvailableTemporalRange`

.. versionadded:: 3.20
%End

    QList< QgsDateTimeRange > allAvailableTemporalRanges() const;
%Docstring
Returns a list of all valid datetime ranges for which temporal data is
available from the provider.

As opposed to
:py:func:`~QgsRasterDataProviderTemporalCapabilities.availableTemporalRange`,
this method is useful when a provider contains a set of non-contiguous
datetime ranges.

.. seealso:: :py:func:`setAllAvailableTemporalRanges`

.. seealso:: :py:func:`availableTemporalRange`

.. versionadded:: 3.20
%End

    void setAvailableReferenceTemporalRange( const QgsDateTimeRange &range );
%Docstring
Sets the available reference datetime ``range``. This is to be used for
bi-temporal based data. Where data can have both nominal and reference
times.

.. seealso:: :py:func:`availableReferenceTemporalRange`
%End

    const QgsDateTimeRange &availableReferenceTemporalRange() const;
%Docstring
Returns the available reference datetime range, which indicates the
maximum extent of datetime values available for reference temporal
ranges from the provider.

.. seealso:: :py:func:`setAvailableReferenceTemporalRange`
%End

    const QgsDateTimeRange &requestedTemporalRange() const;
%Docstring
Returns the requested temporal range. Intended to be used by the
provider in fetching data.
%End

    QgsInterval defaultInterval() const;
%Docstring
Returns the default time step interval corresponding to the available
datetime values for the provider.

.. seealso:: :py:func:`setDefaultInterval`

.. versionadded:: 3.20
%End

    void setDefaultInterval( const QgsInterval &interval );
%Docstring
Sets the default time step ``interval`` corresponding to the available
datetime values for the provider.

.. seealso:: :py:func:`defaultInterval`

.. versionadded:: 3.20
%End


};

/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/raster/qgsrasterdataprovidertemporalcapabilities.h          *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/