qgsmeshdataprovidertemporalcapabilities.h

Go to the documentation of this file.

/***************************************************************************
                         qgsmeshdataprovidertemporalcapabilities.h
                         -----------------------
    begin                : March 2020
    copyright            : (C) 2020 by Vincent Cloarec
    email                : vcloarec at gmail 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 QGSMESHDATAPROVIDERTEMPORALCAPABILITIES_H
#define QGSMESHDATAPROVIDERTEMPORALCAPABILITIES_H
 
#include "qgis.h"
#include "qgsdataprovidertemporalcapabilities.h"
#include "qgsmeshdataset.h"
#include "qgsrange.h"
 
#define INVALID_MESHLAYER_TIME -99999

class CORE_EXPORT QgsMeshDataProviderTemporalCapabilities : public QgsDataProviderTemporalCapabilities
{
  public:
    enum MatchingTemporalDatasetMethod
    {
      FindClosestDatasetBeforeStartRangeTime, 
      FindClosestDatasetFromStartRangeTime    
    };

    QgsMeshDataProviderTemporalCapabilities();

    QgsMeshDatasetIndex datasetIndexClosestBeforeRelativeTime( int group, qint64 timeSinceGlobalReference ) const;

    QgsMeshDatasetIndex datasetIndexClosestFromRelativeTime( int group, qint64 timeSinceGlobalReference ) const;

    void addGroupReferenceDateTime( int group, const QDateTime &reference ) SIP_SKIP;

    void addDatasetTimeInMilliseconds( int group, qint64 time ) SIP_SKIP;

    void addDatasetTime( int group, double time ) SIP_SKIP;

    bool hasReferenceTime() const;

    QDateTime referenceTime() const;

    QgsDateTimeRange timeExtent() const;

    QgsDateTimeRange timeExtent( const QDateTime &reference ) const;

    void setTemporalUnit( Qgis::TemporalUnit temporalUnit );

    Qgis::TemporalUnit temporalUnit() const;

    qint64 datasetTime( const QgsMeshDatasetIndex &index ) const;

    void clear();

    qint64 firstTimeStepDuration( int group ) const;
 
  private:
    QDateTime mGlobalReferenceDateTime;

    QHash<int, QDateTime> mGroupsReferenceDateTime;

    QHash<int, QList<qint64>> mDatasetTimeSinceGroupReference;
 
    Qgis::TemporalUnit mTemporalUnit = Qgis::TemporalUnit::Hours;
};
 
#endif // QGSMESHDATAPROVIDERTEMPORALCAPABILITIES_H