qgsrasterdataprovidertemporalcapabilities.h

Go to the documentation of this file.

/***************************************************************************
                         qgsrasterdataprovidertemporalcapabilities.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 QGSRASTERDATAPROVIDERTEMPORALCAPABILITIES_H
#define QGSRASTERDATAPROVIDERTEMPORALCAPABILITIES_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsrange.h"
#include "qgsinterval.h"
#include "qgsdataprovidertemporalcapabilities.h"
 
class CORE_EXPORT QgsRasterDataProviderTemporalCapabilities : public QgsDataProviderTemporalCapabilities
{
  public:
 
    QgsRasterDataProviderTemporalCapabilities( bool enabled = false );
 
    enum IntervalHandlingMethod
    {
      MatchUsingWholeRange, 
      MatchExactUsingStartOfRange, 
      MatchExactUsingEndOfRange, 
      FindClosestMatchToStartOfRange, 
      FindClosestMatchToEndOfRange 
    };
    // TODO -- add other methods
 
    IntervalHandlingMethod intervalHandlingMethod() const;
 
    void setIntervalHandlingMethod( IntervalHandlingMethod method );
 
    void setAvailableTemporalRange( const QgsDateTimeRange &range );
 
    const QgsDateTimeRange &availableTemporalRange() const;
 
    void setAllAvailableTemporalRanges( const QList< QgsDateTimeRange > &ranges );
 
    QList< QgsDateTimeRange > allAvailableTemporalRanges() const;
 
    void setAvailableReferenceTemporalRange( const QgsDateTimeRange &range );
 
    const QgsDateTimeRange &availableReferenceTemporalRange() const;
 
    const QgsDateTimeRange &requestedTemporalRange() const;
 
    QgsInterval defaultInterval() const;
 
    void setDefaultInterval( const QgsInterval &interval );
 
    void setRequestedTemporalRange( const QgsDateTimeRange &range ) SIP_SKIP;
 
  private:
 
    QgsDateTimeRange mAvailableTemporalRange;
 
    QList< QgsDateTimeRange > mAllAvailableTemporalRanges;
 
    QgsDateTimeRange mRequestedRange;
 
    QgsDateTimeRange mAvailableReferenceRange;
 
    QgsInterval mDefaultInterval;
 
    IntervalHandlingMethod mIntervalMatchMethod = MatchUsingWholeRange;
 
    friend class QgsRasterLayerRenderer;
    friend class TestQgsRasterDataProviderTemporalCapabilities;
 
};
 
#endif // QGSRASTERDATAPROVIDERTEMPORALCAPABILITIES_H