True Axis Physics SDK 1.2.0.1 Beta Documentation
www.trueaxis.com

---

Profiler.h

//---------------------------------------------------------------------------------
// File Name: Profiler.h
// Description: For profiling the running speed of sections of code
//
// Copyright (C) 2004 - 2006 True Axis Pty Ltd, Australia. 
// All Rights Reserved.
//
// History:
//      Created File.
//---------------------------------------------------------------------------------

#ifndef TA_PROFILER_H
#define TA_PROFILER_H

#ifndef TA_SINGLETON_H
#include "Singleton.h"
#endif // TA_SINGLETON_H

#ifndef TA_STRING_H
#include "String.h"
#endif // TA_STRING_H

#ifndef TA_LIST_H
#include "List.h"
#endif // TA_LIST_H


#ifndef TA_PROFILER_ENABLED
//#define TA_PROFILER_ENABLED
#endif // TA_PROFILER_ENABLED
#ifndef TA_TIMER_ENABLED
//#define TA_TIMER_ENABLED
#endif // TA_TIMER_ENABLED

#ifndef TA_TIMER_H
#include "Timer.h"
#endif // TA_TIMER_H

namespace TA
{

#ifdef TA_PROFILER_ENABLED

// Can be use in a hearer file if a profile section needs to be used across source files.
#define PROFILER_EXTERN_SECTION(name)               \
extern Profiler::Section s_profilerSection

// Define a profile section in the source file. Only use globally.
#define PROFILER_DEFINE_SECTION(name)               \
Profiler::Section s_profilerSection##name(#name)

#define PROFILER_ENTER_SECTION(name)                \
s_profilerSection##name.Enter()

#define PROFILER_EXIT_SECTION(name)                 \
s_profilerSection##name.Exit()

// Auto section does a enter section where used and does an exit section when the scope is left
// by creating some data on the stack.
#define PROFILER_AUTO_SECTION(name)                 \
Profiler::AutoSection autoSection##name(s_profilerSection##name)

#else 

#define PROFILER_EXTERN_SECTION(name)
#define PROFILER_DEFINE_SECTION(name)
#define PROFILER_ENTER_SECTION(name)
#define PROFILER_EXIT_SECTION(name)
#define PROFILER_AUTO_SECTION(name)

#endif // TA_PROFILER_ENABLED

#ifdef PROFILER_ENABLED

class TACOMMON_CLASS Profiler
{
    SINGLETON_DEFINE(Profiler)
public:
    // Use the macros above rather than this class directly.
    class Section
    {
    public:
        // No default construction because it is impractical in this case
        // for use with the macros. 
        Section(const char* szName);
        ~Section();

        void Clear();
        void Reset();

        const String& GetName() const { return m_strName; }
        s64 GetTime() const { return m_nAverageTime; }//m_nTotalTime; }
        s64 GetCount() const { return m_nEnterCount; }

        void Enter();
        void Exit();

    private:
        s64 m_nEnterTime;
        s64 m_nAverageTime;
        int m_nTotalTime;
        int m_nEnterCount;
        int m_nExitCount;
        String m_strName;
    };

    class AutoSection
    {
    public:
        // No default construction because it is impractical in this case
        // for use with the macros.
        AutoSection(Section& section);
        ~AutoSection();

    private:
        Section& m_section;
    };

    typedef List<Section*>::ConstIterator ConstIterator;

    void Reset();

    void AddSection(Section* pSection);
    void RemoveSection(Section* pSection);

    ConstIterator GetConstIterator() const { return m_sectionList.GetConstIterator(); }

private:
    typedef List<Section*>::Iterator Iterator;

    List<Section*> m_sectionList;

    Profiler();
    ~Profiler();

    void Initialise();
    void Finalise();

};

#endif // TA_PROFILER_ENABLED

}

#ifdef TA_PROFILER_ENABLED
#include "Profiler.inl"
#endif // TA_PROFILER_ENABLED

#endif // TA_PROFILER_H

---

© Copyright 2004-2006 TRUE AXIS PTY LTD Australia. All rights reserved.