X-Git-Url: https://main.carlh.net/gitweb/?p=dcpomatic.git;a=blobdiff_plain;f=src%2Flib%2Ftimer.h;h=6435155c6c88d774d87f0bb67385a9e9065d2c30;hp=173d0d961f44daed81d3145d4c5a24d3edfe8c75;hb=2d4e8c5f69cc694625ad95dcee554499605f823b;hpb=147cca5876dfbdf56e21289c3a36bec4b4850191 diff --git a/src/lib/timer.h b/src/lib/timer.h index 173d0d961..6435155c6 100644 --- a/src/lib/timer.h +++ b/src/lib/timer.h @@ -1,33 +1,38 @@ /* - Copyright (C) 2012 Carl Hetherington - Copyright (C) 2000-2007 Paul Davis + Copyright (C) 2012-2021 Carl Hetherington - This program is free software; you can redistribute it and/or modify + This file is part of DCP-o-matic. + + DCP-o-matic 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. - This program is distributed in the hope that it will be useful, + DCP-o-matic is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + along with DCP-o-matic. If not, see . */ + /** @file src/timer.h * @brief Some timing classes for debugging and profiling. */ + #ifndef DCPOMATIC_TIMER_H #define DCPOMATIC_TIMER_H + +#include +#include #include #include -#include + /** @class PeriodTimer * @brief A class to allow timing of a period within the caller. @@ -37,9 +42,9 @@ class PeriodTimer { public: - PeriodTimer (std::string n); + explicit PeriodTimer (std::string n); ~PeriodTimer (); - + private: /** name to use when giving output */ @@ -48,31 +53,56 @@ private: struct timeval _start; }; + /** @class StateTimer * @brief A class to allow measurement of the amount of time a program * spends in one of a set of states. * * Once constructed, the caller can call set_state() whenever - * its state changes. When StateTimer is destroyed, it will + * its state changes. When StateTimer is destroyed, it will * output (to cout) a summary of the time spent in each state. */ class StateTimer { public: + explicit StateTimer (std::string n); + /** @param n Name to use when giving output. + * @param s Initial state. + */ StateTimer (std::string n, std::string s); ~StateTimer (); - void set_state (std::string s); + /** @param s New state that the caller is in */ + void set (std::string s); + void unset (); + + std::string name () const { + return _name; + } + + class Counts + { + public: + double total_time = 0; + int number = 0; + }; + + std::map counts () const { + return _counts; + } private: + void set_internal (boost::optional s); + /** name to add to the output */ std::string _name; /** current state */ - std::string _state; + boost::optional _state; /** time that _state was entered */ double _time; - /** time that has been spent in each state so far */ - std::map _totals; + /** total time and number of entries for each state */ + std::map _counts; }; + #endif