src/lib/event_history.h

   1 /*
   2     Copyright (C) 2017-2019 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic 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 DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21 #ifndef DCPOMATIC_EVENT_HISTORY_H
  22 #define DCPOMATIC_EVENT_HISTORY_H
  23
  24 #include <boost/thread/mutex.hpp>
  25 #include <boost/optional.hpp>
  26 #include <list>
  27
  28 class EventHistory
  29 {
  30 public:
  31         explicit EventHistory (int size);
  32
  33         boost::optional<float> rate () const;
  34         void event ();
  35
  36 private:
  37         /** Mutex for _history */
  38         mutable boost::mutex _mutex;
  39         /** List of the times of the last _history_size events
  40             first is the most recently completed.
  41         */
  42         std::list<struct timeval> _history;
  43         /** Number of events that we should keep history for */
  44         int const _size;
  45 };
  46
  47 #endif