qgsrasterlayertemporalproperties.h

Go to the documentation of this file.

/***************************************************************************
                         qgsrasterlayertemporalproperties.h
                         ---------------
    begin                : February 2020
    copyright            : (C) 2020 by Samweli Mwakisambwe
    email                : samweli at kartoza dot com
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
 
#ifndef QGSRASTERLAYERTEMPORALPROPERTIES_H
#define QGSRASTERLAYERTEMPORALPROPERTIES_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsinterval.h"
#include "qgsmaplayertemporalproperties.h"
#include "qgsrange.h"
 
class QgsRasterLayer;

class CORE_EXPORT QgsRasterLayerTemporalProperties : public QgsMapLayerTemporalProperties
{
    Q_OBJECT
 
  public:

    QgsRasterLayerTemporalProperties( QObject *parent SIP_TRANSFERTHIS = nullptr, bool enabled = false );
 
    bool isVisibleInTemporalRange( const QgsDateTimeRange &range ) const override;
    QgsDateTimeRange calculateTemporalExtent( QgsMapLayer *layer ) const override SIP_SKIP;
    QList< QgsDateTimeRange > allTemporalRanges( QgsMapLayer *layer ) const override;

    Qgis::RasterTemporalMode mode() const;

    void setMode( Qgis::RasterTemporalMode mode );

    QgsTemporalProperty::Flags flags() const override;

    Qgis::TemporalIntervalMatchMethod intervalHandlingMethod() const;

    void setIntervalHandlingMethod( Qgis::TemporalIntervalMatchMethod method );

    void setFixedTemporalRange( const QgsDateTimeRange &range );

    const QgsDateTimeRange &fixedTemporalRange() const;

    QMap<int, QgsDateTimeRange> fixedRangePerBand() const;

    void setFixedRangePerBand( const QMap<int, QgsDateTimeRange> &ranges );

    int bandForTemporalRange( QgsRasterLayer *layer, const QgsDateTimeRange &range ) const;

    QList< int > filteredBandsForTemporalRange( QgsRasterLayer *layer, const QgsDateTimeRange &range ) const;

    int bandNumber() const;

    void setBandNumber( int number );

    QDateTime temporalRepresentationOffset() const;

    void setTemporalRepresentationOffset( const QDateTime &offset );

    bool accumulatePixels() const;

    void setAccumulatePixels( bool accumulate );

    const QgsInterval &temporalRepresentationScale() const;

    void setTemporalRepresentationScale( const QgsInterval &scale );
 
    QDomElement writeXml( QDomElement &element, QDomDocument &doc, const QgsReadWriteContext &context ) override;
 
    bool readXml( const QDomElement &element, const QgsReadWriteContext &context ) override;
 
    void setDefaultsFromDataProviderTemporalCapabilities( const QgsDataProviderTemporalCapabilities *capabilities ) override;
 
  private:

    Qgis::RasterTemporalMode mMode = Qgis::RasterTemporalMode::FixedTemporalRange;

    Qgis::TemporalIntervalMatchMethod mIntervalHandlingMethod = Qgis::TemporalIntervalMatchMethod::MatchUsingWholeRange;

    QgsDateTimeRange mFixedRange;
 
    QMap< int, QgsDateTimeRange > mRangePerBand;
 
    int mBandNumber = 1;
 
    QDateTime mTemporalRepresentationOffset;
    QgsInterval mTemporalRepresentationScale;
    bool mAccumulatePixels = false;
};
 
#endif // QGSRASTERLAYERTEMPORALPROPERTIES_H