QGIS API Documentation  3.23.0-Master (eb871beae0)
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"
23 #include "qgsrange.h"
24 #include "qgsinterval.h"
26 
39 {
40  public:
41 
47  QgsRasterDataProviderTemporalCapabilities( bool enabled = false );
48 
55  Qgis::TemporalIntervalMatchMethod intervalHandlingMethod() const;
56 
63  void setIntervalHandlingMethod( Qgis::TemporalIntervalMatchMethod method );
64 
70  void setAvailableTemporalRange( const QgsDateTimeRange &range );
71 
77  const QgsDateTimeRange &availableTemporalRange() const;
78 
89  void setAllAvailableTemporalRanges( const QList< QgsDateTimeRange > &ranges );
90 
101  QList< QgsDateTimeRange > allAvailableTemporalRanges() const;
102 
109  void setAvailableReferenceTemporalRange( const QgsDateTimeRange &range );
110 
117  const QgsDateTimeRange &availableReferenceTemporalRange() const;
118 
123  const QgsDateTimeRange &requestedTemporalRange() const;
124 
132  QgsInterval defaultInterval() const;
133 
141  void setDefaultInterval( const QgsInterval &interval );
142 
153  void setRequestedTemporalRange( const QgsDateTimeRange &range ) SIP_SKIP;
154 
155  private:
156 
165  QgsDateTimeRange mAvailableTemporalRange;
166 
171  QList< QgsDateTimeRange > mAllAvailableTemporalRanges;
172 
174  QgsDateTimeRange mRequestedRange;
175 
179  QgsDateTimeRange mAvailableReferenceRange;
180 
181  QgsInterval mDefaultInterval;
182 
185 
187  friend class TestQgsRasterDataProviderTemporalCapabilities;
188 
189 };
190 
191 #endif // QGSRASTERDATAPROVIDERTEMPORALCAPABILITIES_H
TemporalIntervalMatchMethod
Method to use when resolving a temporal range to a data provider layer or band.
Definition: qgis.h:895
@ MatchUsingWholeRange
Use an exact match to the whole temporal range.
Base class for handling properties relating to a data provider's temporal capabilities.
A representation of the interval between two datetime values.
Definition: qgsinterval.h:42
Implementation of data provider temporal properties for QgsRasterDataProviders.
Implementation of threaded rendering for raster layers.
#define SIP_SKIP
Definition: qgis_sip.h:126