KX_TimeCategoryLogger.h

Go to the documentation of this file.

/*
 * ***** 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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

#if defined(WIN32) && !defined(FREE_WINDOWS)
#pragma warning (disable:4786) // suppress stl-MSVC debug info warning
#endif

#include <map>

#include "KX_TimeLogger.h"

class KX_TimeCategoryLogger {
public:
    typedef int TimeCategory;

    KX_TimeCategoryLogger(unsigned int maxNumMeasurements = 10);

    virtual ~KX_TimeCategoryLogger(void);

    virtual void SetMaxNumMeasurements(unsigned int maxNumMeasurements);

    virtual unsigned int GetMaxNumMeasurements(void) const;

    virtual void AddCategory(TimeCategory tc);

    virtual void StartLog(TimeCategory tc, double now, bool endOtherCategories = true);

    virtual void EndLog(TimeCategory tc, double now);

    virtual void EndLog(double now);

    virtual void NextMeasurement(double now);

    virtual double GetAverage(TimeCategory tc);

    virtual double GetAverage(void);

protected:
    virtual void DisposeLoggers(void);

    typedef std::map<TimeCategory, KX_TimeLogger*> KX_TimeLoggerMap;
    KX_TimeLoggerMap m_loggers;
    unsigned int m_maxNumMeasurements;


#ifdef WITH_CXX_GUARDEDALLOC
public:
    void *operator new(size_t num_bytes) { return MEM_mallocN(num_bytes, "GE:KX_TimeCategoryLogger"); }
    void operator delete( void *mem ) { MEM_freeN(mem); }
#endif
};

#endif // __KX_TIME_CATEGORY_LOGGER_H