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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
|
/**
* $Id: KX_TimeCategoryLogger.h 14444 2008-04-16 22:40:48Z hos $
*
* ***** BEGIN GPL LICENSE BLOCK *****
*
* 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*
* The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
* All rights reserved.
*
* The Original Code is: all of this file.
*
* Contributor(s): none yet.
*
* ***** END GPL LICENSE BLOCK *****
*/
#ifndef __KX_TIME_CATEGORY_LOGGER_H
#define __KX_TIME_CATEGORY_LOGGER_H
#ifdef WIN32
#pragma warning (disable:4786) // suppress stl-MSVC debug info warning
#endif
#include <map>
#include "KX_TimeLogger.h"
/**
* Stores and manages time measurements by category.
* Categories can be added dynamically.
* Average measurements can be established for each separate category
* or for all categories together.
*/
class KX_TimeCategoryLogger {
public:
typedef int TimeCategory;
/**
* Constructor.
* @param maxNumMesasurements Maximum number of measurements stored (> 1).
*/
KX_TimeCategoryLogger(unsigned int maxNumMeasurements = 10);
/**
* Destructor.
*/
virtual ~KX_TimeCategoryLogger(void);
/**
* Changes the maximum number of measurements that can be stored.
*/
virtual void SetMaxNumMeasurements(unsigned int maxNumMeasurements);
/**
* Changes the maximum number of measurements that can be stored.
*/
virtual unsigned int GetMaxNumMeasurements(void) const;
/**
* Adds a category.
* @param category The new category.
*/
virtual void AddCategory(TimeCategory tc);
/**
* Starts logging in current measurement for the given category.
* @param tc The category to log to.
* @param now The current time.
* @param endOtherCategories Whether to stop logging to other categories.
*/
virtual void StartLog(TimeCategory tc, double now, bool endOtherCategories = true);
/**
* End logging in current measurement for the given category.
* @param tc The category to log to.
* @param now The current time.
*/
virtual void EndLog(TimeCategory tc, double now);
/**
* End logging in current measurement for all categories.
* @param now The current time.
*/
virtual void EndLog(double now);
/**
* Logs time in next measurement.
* @param now The current time.
*/
virtual void NextMeasurement(double now);
/**
* Returns average of all but the current measurement time.
* @return The average of all but the current measurement.
*/
virtual double GetAverage(TimeCategory tc);
/**
* Returns average for grand total.
*/
virtual double GetAverage(void);
protected:
/**
* Disposes loggers.
*/
virtual void DisposeLoggers(void);
/** Storage for the loggers. */
typedef std::map<TimeCategory, KX_TimeLogger*> KX_TimeLoggerMap;
KX_TimeLoggerMap m_loggers;
/** Maximum number of measurements. */
unsigned int m_maxNumMeasurements;
};
#endif // __KX_TIME_CATEGORY_LOGGER_H
|
