summaryrefslogtreecommitdiff
path: root/src/lib/timer.h
blob: 8c4b046bf7e761fc57bf2cde5d4d8496bdccdc03 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
/*
    Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
    Copyright (C) 2000-2007 Paul Davis

    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.

    This program 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.

*/

/** @file src/timer.h
 *  @brief Some timing classes for debugging and profiling.
 */

#ifndef DCPOMATIC_TIMER_H
#define DCPOMATIC_TIMER_H

#include <sys/time.h>
#include <string>
#include <map>

/** @class PeriodTimer
 *  @brief A class to allow timing of a period within the caller.
 *
 *  On destruction, it will output the time since its construction.
 */
class PeriodTimer
{
public:
	PeriodTimer (std::string n);
	~PeriodTimer ();
	
private:

	/** name to use when giving output */
	std::string _name;
	/** time that this class was constructed */
	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
 *  output (to cout) a summary of the time spent in each state.
 */
class StateTimer
{
public:
	StateTimer (std::string n, std::string s);
	~StateTimer ();

	void set_state (std::string s);

private:
	/** name to add to the output */
	std::string _name;
	/** current state */
	std::string _state;
	/** time that _state was entered */
	double _time;
	/** time that has been spent in each state so far */
	std::map<std::string, double> _totals;
};

#endif