QGIS API Documentation 3.27.0-Master (95e00c50d2)
qgsrasterdataprovidertemporalcapabilities.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgsrasterdataprovidertemporalcapabilities.cpp
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
19
22{
23}
24
25Qgis::RasterTemporalCapabilityFlags QgsRasterDataProviderTemporalCapabilities::flags() const
26{
27 return mFlags;
28}
29
30void QgsRasterDataProviderTemporalCapabilities::setFlags( Qgis::RasterTemporalCapabilityFlags flags )
31{
32 mFlags = flags;
33}
34
36{
39
40 mAvailableTemporalRange = dateTimeRange;
41}
42
44{
45 return mAvailableTemporalRange;
46}
47
49{
50 mAllAvailableTemporalRanges = ranges;
51}
52
54{
55 return mAllAvailableTemporalRanges;
56}
57
59{
62
63 mAvailableReferenceRange = dateTimeRange;
64}
65
67{
68 return mAvailableReferenceRange;
69}
70
72{
73 mRequestedRange = dateTimeRange;
74}
75
77{
78 return mDefaultInterval;
79}
80
82{
83 mDefaultInterval = defaultInterval;
84}
85
87{
88 return mRequestedRange;
89}
90
92{
93 return mIntervalMatchMethod;
94}
95
97{
98 if ( mIntervalMatchMethod == mode )
99 return;
100 mIntervalMatchMethod = mode;
101}
TemporalIntervalMatchMethod
Method to use when resolving a temporal range to a data provider layer or band.
Definition: qgis.h:1286
Base class for handling properties relating to a data provider's temporal capabilities.
bool hasTemporalCapabilities() const
Returns true if the provider has temporal capabilities available.
void setHasTemporalCapabilities(bool available)
Sets whether the provider has temporal capabilities available.
A representation of the interval between two datetime values.
Definition: qgsinterval.h:42
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.