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