qgstemporalutils.h

Go to the documentation of this file.

/***************************************************************************
  qgstemporalutils.h
  ------------------
  Date                 : March 2020
  Copyright            : (C) 2020 by Nyall Dawson
  Email                : nyall dot dawson 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 QGSTEMPORALUTILS_H
#define QGSTEMPORALUTILS_H
 
#include "qgis_core.h"
#include "qgsinterval.h"
#include "qgsrange.h"
 
class QgsProject;
class QgsMapSettings;
class QgsFeedback;
class QgsMapDecoration;
 
#ifndef SIP_RUN

class CORE_EXPORT QgsTimeDuration
{
  public:

    int years = 0;
    int months = 0;
    int weeks = 0;
    int days = 0;
    int hours = 0;
    int minutes = 0;
    double seconds = 0;

    bool isNull() const
    {
      return !years && !months && !days &&
             !hours && !minutes && !seconds;
    }
 
    // TODO c++20 - replace with = default
    bool operator==( const QgsTimeDuration &other ) const
    {
      return years == other.years && months == other.months && weeks == other.weeks &&
             days == other.days && hours == other.hours &&
             minutes == other.minutes && seconds == other.seconds;
    }
 
    bool operator!=( const QgsTimeDuration &other ) const
    {
      return !( *this == other );
    }

    QgsInterval toInterval() const;

    QString toString() const;

    long long toSeconds() const;

    QDateTime addToDateTime( const QDateTime &dateTime ) const;

    static QgsTimeDuration fromString( const QString &string, bool &ok );
 
};
#endif
 

 
class CORE_EXPORT QgsTemporalUtils
{
  public:

    static QgsDateTimeRange calculateTemporalRangeForProject( QgsProject *project );

    static QList< QgsDateTimeRange > usedTemporalRangesForProject( QgsProject *project );

    struct AnimationExportSettings
    {
      QgsDateTimeRange animationRange;

      QgsInterval frameDuration;

      bool temporalRangeCumulative = false;

      QString outputDirectory;

      QString fileNameTemplate;

      QList<QgsMapDecoration *> decorations;

      QList<QgsDateTimeRange> availableTemporalRanges;

      double frameRate = 30;
 
    };

    static bool exportAnimation( const QgsMapSettings &mapSettings, const AnimationExportSettings &settings, QString &error SIP_OUT, QgsFeedback *feedback = nullptr );

    static QDateTime calculateFrameTime( const QDateTime &start, const long long frame, const QgsInterval &interval );

    static QList< QDateTime > calculateDateTimesUsingDuration( const QDateTime &start, const QDateTime &end, const QString &duration, bool &ok SIP_OUT, bool &maxValuesExceeded SIP_OUT, int maxValues = -1 );
 
#ifndef SIP_RUN

    static QList< QDateTime > calculateDateTimesUsingDuration( const QDateTime &start, const QDateTime &end, const QgsTimeDuration &duration, bool &maxValuesExceeded SIP_OUT, int maxValues = -1 );
#endif

    static QList< QDateTime > calculateDateTimesFromISO8601( const QString &string, bool &ok SIP_OUT, bool &maxValuesExceeded SIP_OUT, int maxValues = -1 );
 
};
 
 
#endif // QGSTEMPORALUTILS_H