QGIS API Documentation 3.99.0-Master (21b3aa880ba)
Loading...
Searching...
No Matches
qgsrasterdataprovidertemporalcapabilities.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsrasterdataprovidertemporalcapabilities.h
3 ---------------
4 begin : February 2020
5 copyright : (C) 2020 by Samweli Mwakisambwe
6 email : samweli at kartoza dot com
7 ***************************************************************************/
8
9/***************************************************************************
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
15 * *
16 ***************************************************************************/
17
18#ifndef QGSRASTERDATAPROVIDERTEMPORALCAPABILITIES_H
19#define QGSRASTERDATAPROVIDERTEMPORALCAPABILITIES_H
20
21#include "qgis_core.h"
22#include "qgis_sip.h"
24#include "qgsinterval.h"
25#include "qgsrange.h"
26
39{
40 public:
41
47 QgsRasterDataProviderTemporalCapabilities( bool enabled = false );
48
55
62
70
78
85
92
103 void setAllAvailableTemporalRanges( const QList< QgsDateTimeRange > &ranges );
104
115 QList< QgsDateTimeRange > allAvailableTemporalRanges() const;
116
124
132
138
147
155 void setDefaultInterval( const QgsInterval &interval );
156
168
169 private:
170
179 QgsDateTimeRange mAvailableTemporalRange;
180
185 QList< QgsDateTimeRange > mAllAvailableTemporalRanges;
186
188 QgsDateTimeRange mRequestedRange;
189
193 QgsDateTimeRange mAvailableReferenceRange;
194
195 QgsInterval mDefaultInterval;
196
199
201
204
205};
206
207#endif // QGSRASTERDATAPROVIDERTEMPORALCAPABILITIES_H
TemporalIntervalMatchMethod
Method to use when resolving a temporal range to a data provider layer or band.
Definition qgis.h:2637
@ MatchUsingWholeRange
Use an exact match to the whole temporal range.
Definition qgis.h:2638
QFlags< RasterTemporalCapabilityFlag > RasterTemporalCapabilityFlags
Flags for raster layer temporal capabilities.
Definition qgis.h:2662
QgsDataProviderTemporalCapabilities(bool available=false)
Constructor for QgsDataProviderTemporalCapabilities.
A representation of the interval between two datetime values.
Definition qgsinterval.h:47
void setIntervalHandlingMethod(Qgis::TemporalIntervalMatchMethod method)
Sets the desired method to use when resolving a temporal interval to matching layers or bands in the ...
const QgsDateTimeRange & requestedTemporalRange() const
Returns the requested temporal range.
QgsInterval defaultInterval() const
Returns the default time step interval corresponding to the available datetime values for the provide...
void setAvailableReferenceTemporalRange(const QgsDateTimeRange &range)
Sets the available reference datetime range.
const QgsDateTimeRange & availableReferenceTemporalRange() const
Returns the available reference datetime range, which indicates the maximum extent of datetime values...
QList< QgsDateTimeRange > allAvailableTemporalRanges() const
Returns a list of all valid datetime ranges for which temporal data is available from the provider.
void setRequestedTemporalRange(const QgsDateTimeRange &range)
Sets the requested temporal range to retrieve when returning data from the associated data provider.
void setDefaultInterval(const QgsInterval &interval)
Sets the default time step interval corresponding to the available datetime values for the provider.
void setAllAvailableTemporalRanges(const QList< QgsDateTimeRange > &ranges)
Sets a list of all valid datetime ranges for which temporal data is available from the provider.
QgsRasterDataProviderTemporalCapabilities(bool enabled=false)
Constructor for QgsRasterDataProviderTemporalProperties.
void setAvailableTemporalRange(const QgsDateTimeRange &range)
Sets the overall datetime range extent from which temporal data is available from the provider.
Qgis::TemporalIntervalMatchMethod intervalHandlingMethod() const
Returns the desired method to use when resolving a temporal interval to matching layers or bands in t...
void setFlags(Qgis::RasterTemporalCapabilityFlags flags)
Sets the capability flags for the provider.
Qgis::RasterTemporalCapabilityFlags flags() const
Returns the capability flags for the provider.
const QgsDateTimeRange & availableTemporalRange() const
Returns the overall datetime range extent from which temporal data is available from the provider.
#define SIP_SKIP
Definition qgis_sip.h:134
QgsTemporalRange< QDateTime > QgsDateTimeRange
QgsRange which stores a range of date times.
Definition qgsrange.h:761