X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Flib%2Ftimer.h;h=be3706607811d4c7c668430bf652162d7d434562;hb=HEAD;hp=4293fee0deefd5abe5fd23c8ef84d72be4462d63;hpb=e60bb3e51bd1508b149e6b8f6608f09b5196ae26;p=dcpomatic.git diff --git a/src/lib/timer.h b/src/lib/timer.h index 4293fee0d..be3706607 100644 --- a/src/lib/timer.h +++ b/src/lib/timer.h @@ -1,34 +1,39 @@ /* - 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 + /** @class PeriodTimer * @brief A class to allow timing of a period within the caller. * @@ -37,7 +42,7 @@ class PeriodTimer { public: - PeriodTimer (std::string n); + explicit PeriodTimer (std::string n); ~PeriodTimer (); private: @@ -48,6 +53,7 @@ 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. @@ -59,20 +65,44 @@ private: 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; + double _time = 0; + /** total time and number of entries for each state */ + std::map _counts; }; + #endif