QGIS API Documentation  3.17.0-Master (8af46bc54f)
qgsrasterlayertemporalproperties.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsrasterlayertemporalproperties.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 
19 #ifndef QGSRASTERLAYERTEMPORALPROPERTIES_H
20 #define QGSRASTERLAYERTEMPORALPROPERTIES_H
21 
22 #include "qgis_core.h"
23 #include "qgis_sip.h"
24 #include "qgsrange.h"
27 
36 {
37  Q_OBJECT
38 
39  public:
40 
46  QgsRasterLayerTemporalProperties( QObject *parent SIP_TRANSFERTHIS = nullptr, bool enabled = false );
47 
48  bool isVisibleInTemporalRange( const QgsDateTimeRange &range ) const override;
49  QgsDateTimeRange calculateTemporalExtent( QgsMapLayer *layer ) const override SIP_SKIP;
50 
55  {
56  ModeFixedTemporalRange = 0,
57  ModeTemporalRangeFromDataProvider = 1,
58  };
59 
65  TemporalMode mode() const;
66 
72  void setMode( TemporalMode mode );
73 
77  QgsTemporalProperty::Flags flags() const override;
78 
86 
93  void setIntervalHandlingMethod( QgsRasterDataProviderTemporalCapabilities::IntervalHandlingMethod method );
94 
105  void setFixedTemporalRange( const QgsDateTimeRange &range );
106 
115  const QgsDateTimeRange &fixedTemporalRange() const;
116 
117  QDomElement writeXml( QDomElement &element, QDomDocument &doc, const QgsReadWriteContext &context ) override;
118 
119  bool readXml( const QDomElement &element, const QgsReadWriteContext &context ) override;
120 
122 
123  private:
124 
126  TemporalMode mMode = ModeFixedTemporalRange;
127 
130 
132  QgsDateTimeRange mFixedRange;
133 };
134 
135 #endif // QGSRASTERLAYERTEMPORALPROPERTIES_H
The class is used as a container of context for various read/write operations on other objects...
Base class for all map layer types.
Definition: qgsmaplayer.h:83
#define SIP_TRANSFERTHIS
Definition: qgis_sip.h:53
IntervalHandlingMethod
Method to use when resolving a temporal range to a data provider layer or band.
virtual QgsDateTimeRange calculateTemporalExtent(QgsMapLayer *layer) const
Attempts to calculate the overall temporal extent for the specified layer, using the settings defined...
virtual QDomElement writeXml(QDomElement &element, QDomDocument &doc, const QgsReadWriteContext &context)=0
Writes the properties to a DOM element, to be used later with readXml().
Base class for handling properties relating to a data provider's temporal capabilities.
virtual bool readXml(const QDomElement &element, const QgsReadWriteContext &context)=0
Reads temporal properties from a DOM element previously written by writeXml().
#define SIP_SKIP
Definition: qgis_sip.h:126
virtual bool isVisibleInTemporalRange(const QgsDateTimeRange &range) const
Returns true if the layer should be visible and rendered for the specified time range.
Base class for storage of map layer temporal properties.
virtual QgsTemporalProperty::Flags flags() const
Returns flags associated to the temporal property.
TemporalMode
Mode of the raster temporal properties.
virtual void setDefaultsFromDataProviderTemporalCapabilities(const QgsDataProviderTemporalCapabilities *capabilities)=0
Sets the layers temporal settings to appropriate defaults based on a provider's temporal capabilities...
Implementation of map layer temporal properties for raster layers.