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 <chrono>
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
 
#include <QString>
#include <QVariant>
 
using namespace Qt::StringLiterals;
 
#ifdef SIP_RUN
// clang-format off
% ModuleHeaderCode
#include "qgsunittypes.h"
% End
// clang-format on
#endif
  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 );

    QgsInterval( std::chrono::milliseconds milliseconds ) SIP_SKIP;

    QgsInterval( double duration, Qgis::TemporalUnit unit );

    QgsInterval( double years, double months, double weeks, double days, double hours, double minutes, double seconds );
 
#ifdef SIP_RUN
    // clang-format off
    SIP_PYOBJECT __repr__();
    % MethodCode
    QString str;
    if ( ! sipCpp->isValid() )
      str = u"<QgsInterval: invalid>"_s;
    else if ( sipCpp->originalUnit() != Qgis::TemporalUnit::Unknown )
      str = u"<QgsInterval: %1 %2>"_s.arg( sipCpp->originalDuration() ).arg( QgsUnitTypes::toString( sipCpp->originalUnit() ) );
    else
      str = u"<QgsInterval: %1 seconds>"_s.arg( sipCpp->seconds() );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
// clang-format on
#endif

      double years() const;

    void setYears( double years );

    double months() const;

    void setMonths( double months );

    double weeks() const;

    void setWeeks( double weeks );

    double days() const;

    void setDays( double days );

    double hours() const;

    void setHours( double hours );

    double minutes() const;

    void setMinutes( double minutes );

    double seconds() const { return mSeconds; }

    void setSeconds( double seconds );

    bool isValid() const { return mValid; }

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

    double originalDuration() const { return mOriginalDuration; }

    Qgis::TemporalUnit originalUnit() const { return mOriginalUnit; }
 
    bool operator==( QgsInterval other ) const
    {
      if ( !mValid && !other.mValid )
        return true;
      else if ( mValid && other.mValid && ( mOriginalUnit != Qgis::TemporalUnit::Unknown || other.mOriginalUnit != Qgis::TemporalUnit::Unknown ) )
        return mOriginalUnit == other.mOriginalUnit && mOriginalDuration == other.mOriginalDuration;
      else if ( mValid && other.mValid )
        return qgsDoubleNear( mSeconds, other.mSeconds );
      else
        return false;
    }
 
    bool operator!=( QgsInterval other ) const { return !( *this == other ); }

    static QgsInterval fromString( const QString &string );

    operator QVariant() const { return QVariant::fromValue( *this ); }
 
  private:
    double mSeconds = 0.0;

    bool mValid = false;

    double mOriginalDuration = 0.0;

    Qgis::TemporalUnit mOriginalUnit = Qgis::TemporalUnit::Unknown;
};
 
Q_DECLARE_METATYPE( QgsInterval )
 
#ifndef SIP_RUN
 

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 CORE_EXPORT operator<<( QDebug dbg, const QgsInterval &interval );
 
#endif
 
#endif // QGSINTERVAL_H