blender/source/gameengine/Ketsji/KX_TimeLogger.h

116 lines
2.8 KiB
C
Raw Normal View History

2002-10-12 11:37:38 +00:00
/**
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
2002-10-12 11:37:38 +00:00
*
* 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.
2002-10-12 11:37:38 +00:00
*
* 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,
2010-02-12 13:34:04 +00:00
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
2002-10-12 11:37:38 +00:00
*
* 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 *****
2002-10-12 11:37:38 +00:00
*/
#ifndef __KX_TIME_LOGGER_H
#define __KX_TIME_LOGGER_H
#if defined(WIN32) && !defined(FREE_WINDOWS)
2002-10-12 11:37:38 +00:00
#pragma warning (disable:4786) // suppress stl-MSVC debug info warning
#endif
#include <deque>
#ifdef WITH_CXX_GUARDEDALLOC
#include "MEM_guardedalloc.h"
#endif
2002-10-12 11:37:38 +00:00
/**
* Stores and manages time measurements.
*/
class KX_TimeLogger {
public:
/**
* Constructor.
* @param maxNumMesasurements Maximum number of measurements stored (>1).
*/
KX_TimeLogger(unsigned int maxNumMeasurements = 10);
/**
* Destructor.
*/
virtual ~KX_TimeLogger(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;
/**
* Starts logging in current measurement.
* @param now The current time.
*/
virtual void StartLog(double now);
/**
* End logging in current measurement.
* @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.
* @return The average of all but the current measurement.
*/
virtual double GetAverage(void) const;
protected:
/** Storage for the measurements. */
std::deque<double> m_measurements;
/** Maximum number of measurements. */
unsigned int m_maxNumMeasurements;
/** Time at start of logging. */
double m_logStart;
/** State of logging. */
bool m_logging;
#ifdef WITH_CXX_GUARDEDALLOC
public:
void *operator new(size_t num_bytes) { return MEM_mallocN(num_bytes, "GE:KX_TimeLogger"); }
void operator delete( void *mem ) { MEM_freeN(mem); }
#endif
2002-10-12 11:37:38 +00:00
};
#endif // __KX_TIME_LOGGER_H