qgsinterval.h

Go to the documentation of this file.

/***************************************************************************
  qgsinterval.h
  -------------
  Date                 : May 2016
  Copyright            : (C) 2016 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 QGSINTERVAL_H
#define QGSINTERVAL_H

/***************************************************************************
 * This class is considered CRITICAL and any change MUST be accompanied with
 * full unit tests in test_qgsinterval.py.
 * See details in QEP #17
 ****************************************************************************/

#include <QVariant>

#include "qgis_sip.h"
#include "qgis_core.h"

class QString;

class CORE_EXPORT QgsInterval
{
  public:

    // YEAR const value taken from postgres query
    // SELECT EXTRACT(EPOCH FROM interval '1 year')
    static const int YEARS = 31557600;
    static const int MONTHS = 60 * 60 * 24 * 30;
    static const int WEEKS = 60 * 60 * 24 * 7;
    static const int DAY = 60 * 60 * 24;
    static const int HOUR = 60 * 60;
    static const int MINUTE = 60;

    QgsInterval() = default;

    QgsInterval( double seconds );

    double years() const { return mSeconds / YEARS; }

    void setYears( double years ) { mSeconds = years * YEARS; mValid = true; }

    double months() const { return mSeconds / MONTHS; }

    void setMonths( double months ) { mSeconds = months * MONTHS; mValid = true; }

    double weeks() const { return mSeconds / WEEKS; }

    void setWeeks( double weeks ) { mSeconds = weeks * WEEKS; mValid = true; }

    double days() const { return mSeconds / DAY; }

    void setDays( double days ) { mSeconds = days * DAY; mValid = true; }

    double hours() const { return mSeconds / HOUR; }

    void setHours( double hours ) { mSeconds = hours * HOUR; mValid = true; }

    double minutes() const { return mSeconds / MINUTE; }

    void setMinutes( double minutes ) { mSeconds = minutes * MINUTE; mValid = true; }

    double seconds() const { return mSeconds; }

    void setSeconds( double seconds ) { mSeconds = seconds; mValid = true; }

    bool isValid() const { return mValid; }

    void setValid( bool valid ) { mValid = valid; }

    bool operator==( QgsInterval other ) const;

    static QgsInterval fromString( const QString &string );

    operator QVariant() const
    {
      return QVariant::fromValue( *this );
    }

  private:

    double mSeconds = 0.0;

    bool mValid = false;
};

Q_DECLARE_METATYPE( QgsInterval )

#ifndef SIP_RUN

QgsInterval CORE_EXPORT operator-( const QDateTime &datetime1, const QDateTime &datetime2 );

QgsInterval CORE_EXPORT operator-( QDate date1, QDate date2 );

QgsInterval CORE_EXPORT operator-( QTime time1, QTime time2 );

QDateTime CORE_EXPORT operator+( const QDateTime &start, const QgsInterval &interval );

QDebug operator<<( QDebug dbg, const QgsInterval &interval );
\
#endif

#endif // QGSINTERVAL_H