optionally use guarded alloc for tiles compositor, also replace allocation functions...
[blender.git] / source / gameengine / Ketsji / KX_TimeLogger.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file KX_TimeLogger.h
29  *  \ingroup ketsji
30  */
31
32 #ifndef __KX_TIMELOGGER_H__
33 #define __KX_TIMELOGGER_H__
34
35 #if defined(WIN32) && !defined(FREE_WINDOWS)
36 #pragma warning (disable:4786) // suppress stl-MSVC debug info warning
37 #endif
38
39 #include <deque>
40
41 #ifdef WITH_CXX_GUARDEDALLOC
42 #include "MEM_guardedalloc.h"
43 #endif
44
45 /**
46  * Stores and manages time measurements.
47  */
48 class KX_TimeLogger {
49 public:
50         /**
51          * Constructor.
52          * \param maxNumMesasurements Maximum number of measurements stored (>1).
53          */
54         KX_TimeLogger(unsigned int maxNumMeasurements = 10);
55
56         /**
57          * Destructor.
58          */
59         virtual ~KX_TimeLogger(void);
60
61         /**
62          * Changes the maximum number of measurements that can be stored.
63          */
64         virtual void SetMaxNumMeasurements(unsigned int maxNumMeasurements);
65
66         /**
67          * Changes the maximum number of measurements that can be stored.
68          */
69         virtual unsigned int GetMaxNumMeasurements(void) const;
70
71         /**
72          * Starts logging in current measurement.
73          * \param now   The current time.
74          */
75         virtual void StartLog(double now);
76
77         /**
78          * End logging in current measurement.
79          * \param now   The current time.
80          */
81         virtual void EndLog(double now);
82
83         /**
84          * Logs time in next measurement.
85          * \param now   The current time.
86          */
87         virtual void NextMeasurement(double now);
88
89         /**
90          * Returns average of all but the current measurement.
91          * \return The average of all but the current measurement.
92          */
93         virtual double GetAverage(void) const;
94
95 protected:
96         /** Storage for the measurements. */
97         std::deque<double> m_measurements;
98
99         /** Maximum number of measurements. */
100         unsigned int m_maxNumMeasurements;
101
102         /** Time at start of logging. */
103         double m_logStart;
104
105         /** State of logging. */
106         bool m_logging;
107
108
109 #ifdef WITH_CXX_GUARDEDALLOC
110         MEM_CXX_CLASS_ALLOC_FUNCS("GE:KX_TimeLogger")
111 #endif
112 };
113
114 #endif // __KX_TIMELOGGER_H__
115