src/gui/properties/speedplotview.h

   1 /*
   2  * Bittorrent Client using Qt and libtorrent.
   3  * Copyright (C) 2021 Prince Gupta <guptaprince8832@gmail.com>
   4  * Copyright (C) 2015 Anton Lashkov <lenton_91@mail.ru>
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License
   8  * as published by the Free Software Foundation; either version 2
   9  * of the License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  19  *
  20  * In addition, as a special exception, the copyright holders give permission to
  21  * link this program with the OpenSSL project's "OpenSSL" library (or with
  22  * modified versions of it that use the same license as the "OpenSSL" library),
  23  * and distribute the linked executables. You must obey the GNU General Public
  24  * License in all respects for all of the code used other than "OpenSSL".  If you
  25  * modify file(s), you may extend this exception to your version of the file(s),
  26  * but you are not obligated to do so. If you do not wish to do so, delete this
  27  * exception statement from your version.
  28  */
  29
  30 #pragma once
  31
  32 #include <array>
  33 #include <chrono>
  34
  35 #ifndef Q_MOC_RUN
  36 #include <boost/circular_buffer.hpp>
  37 #endif
  38
  39 #include <QElapsedTimer>
  40 #include <QGraphicsView>
  41 #include <QMap>
  42
  43 class QPen;
  44
  45 using std::chrono::milliseconds;
  46 using namespace std::chrono_literals;
  47
  48 class SpeedPlotView final : public QGraphicsView
  49 {
  50     Q_OBJECT
  51     Q_DISABLE_COPY_MOVE(SpeedPlotView)
  52
  53 public:
  54     enum GraphID
  55     {
  56         UP = 0,
  57         DOWN,
  58         PAYLOAD_UP,
  59         PAYLOAD_DOWN,
  60         OVERHEAD_UP,
  61         OVERHEAD_DOWN,
  62         DHT_UP,
  63         DHT_DOWN,
  64         TRACKER_UP,
  65         TRACKER_DOWN,
  66
  67         NB_GRAPHS
  68     };
  69
  70     enum TimePeriod
  71     {
  72         MIN1 = 0,
  73         MIN5,
  74         MIN30,
  75         HOUR3,
  76         HOUR6,
  77         HOUR12,
  78         HOUR24
  79     };
  80
  81     using SampleData = std::array<quint64, NB_GRAPHS>;
  82
  83     explicit SpeedPlotView(QWidget *parent = nullptr);
  84
  85     void setGraphEnable(GraphID id, bool enable);
  86     void setPeriod(TimePeriod period);
  87
  88     void pushPoint(const SampleData &point);
  89
  90 protected:
  91     void paintEvent(QPaintEvent *event) override;
  92
  93 private:
  94     struct Sample
  95     {
  96         milliseconds duration;
  97         SampleData data;
  98     };
  99
 100     using DataCircularBuffer = boost::circular_buffer<Sample>;
 101
 102     class Averager
 103     {
 104     public:
 105         Averager(milliseconds duration, milliseconds resolution);
 106
 107         bool push(const SampleData &sampleData); // returns true if there is new data to display
 108
 109         const DataCircularBuffer &data() const;
 110
 111     private:
 112         const milliseconds m_resolution;
 113         const milliseconds m_maxDuration;
 114         milliseconds m_currentDuration {0};
 115         int m_counter = 0;
 116         SampleData m_accumulator {};
 117         DataCircularBuffer m_sink {};
 118         QElapsedTimer m_lastSampleTime;
 119     };
 120
 121     struct GraphProperties
 122     {
 123         GraphProperties();
 124         GraphProperties(const QString &name, const QPen &pen, bool enable = false);
 125
 126         QString name;
 127         QPen pen;
 128         bool enable;
 129     };
 130
 131     quint64 maxYValue() const;
 132     const DataCircularBuffer &currentData() const;
 133
 134     Averager m_averager5Min {5min, 1s};
 135     Averager m_averager30Min {30min, 6s};
 136     Averager m_averager6Hour {6h, 36s};
 137     Averager m_averager12Hour {12h, 72s};
 138     Averager m_averager24Hour {24h, 144s};
 139     Averager *m_currentAverager {&m_averager5Min};
 140
 141     QMap<GraphID, GraphProperties> m_properties;
 142     milliseconds m_currentMaxDuration {0};
 143 };