qgsdatetimestatisticalsummary.h

Go to the documentation of this file.

/***************************************************************************
  qgsdatetimestatisticalsummary.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 QGSDATETIMESTATISTICALSUMMARY_H
#define QGSDATETIMESTATISTICALSUMMARY_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsinterval.h"
 
#include <QDateTime>
#include <QSet>
#include <QVariantList>
 
/***************************************************************************
 * This class is considered CRITICAL and any change MUST be accompanied with
 * full unit tests in test_qgsdatetimestatisticalsummary.py.
 * See details in QEP #17
 ****************************************************************************/

 
class CORE_EXPORT QgsDateTimeStatisticalSummary
{
  public:
    QgsDateTimeStatisticalSummary( Qgis::DateTimeStatistics stats = Qgis::DateTimeStatistic::All );

    Qgis::DateTimeStatistics statistics() const { return mStatistics; }

    void setStatistics( Qgis::DateTimeStatistics stats ) { mStatistics = stats; }

    void reset();

    void calculate( const QVariantList &values );

    void addValue( const QVariant &value );

    void finalize();

    QVariant statistic( Qgis::DateTimeStatistic stat ) const;

    int count() const { return mCount; }

    int countDistinct() const { return mValues.count(); }

    QSet< QDateTime > distinctValues() const { return mValues; }

    int countMissing() const { return mCountMissing; }

    QDateTime min() const { return mMin; }

    QDateTime max() const { return mMax; }

    QgsInterval range() const;

    static QString displayName( Qgis::DateTimeStatistic statistic );
 
  private:
    Qgis::DateTimeStatistics mStatistics;
 
    int mCount;
    QSet< QDateTime > mValues;
    int mCountMissing;
    QDateTime mMin;
    QDateTime mMax;
    bool mIsTimes;
 
    void testDateTime( const QDateTime &dateTime, bool isNull );
};
 
#endif // QGSDATETIMESTATISTICALSUMMARY_H