GUIPerfMon.h

/*
* Copyright (C) TES Electronic Solutions GmbH,
* All Rights Reserved.
* Contact: info@guiliani.de
*
* This file is part of the Guiliani HMI framework
* for the development of graphical user interfaces on embedded systems.
*/
 
#ifndef GUIPERFMON__H_
#define GUIPERFMON__H_
 
#include "eC_Types.h"
#include "eC_String.h"
 
#include "GUIConfigDebug.h"
 
#include "GUIComponentManager.h"
 
// Exclude this class from the doxygen documentation
#ifndef DOXYGEN
 
 
#ifndef GUILIANI_USE_PERFMON
#define CONTROLPOINTSTART(cp);
#define CONTROLPOINTEND(cp);
#define CONTROLPOINTPERFMEASURE();
#else
 
#define GETPERFMON CGUIComponentManager::GetPerfMon()
 
#define CONTROLPOINTSTART(cp) GETPERFMON.ControlPointStart(cp);
 
#define CONTROLPOINTEND(cp) GETPERFMON.ControlPointEnd(cp);
 
#define CONTROLPOINTPERFMEASURE() GETPERFMON.CalcPerfMeasures();
 
class CGUIPerfMon
{
    friend class CGUIComponentManager; 
 
public:
    enum PerfMonControlPoint_t
    {
        eFrameDuration,
        eInputWrapper,
        eGuiInit,
        eHandleEvent,
        eCmdHdlProcess,
        eGetTimerProcess,
        eRedrawGUI,
        eText,
        eLoadImg,
        eLoadFont,
        eRequiredSpace,
        eUser00,
        eUser01,
        eUser02,
        eUser03,
        eUser04,
        eUser05,
        eUser06,
        eUser07,
        eUser08,
        eUser09,
        eNumOfElements
    };
 
    static const eC_UInt kNumOfAvailableUserEntries = eRequiredSpace;
 
    enum LogMode_t
    {
        eModeFile,
        eModeCallback
    };
 
    typedef void(*PerfMonCallback_t)(eC_UInt*, eC_Int);
 
public:
    static void CreateInstance();
 
    static void DeleteInstance();
 
 
    void ControlPointStart(PerfMonControlPoint_t eCP)
    {
        m_StartCP[eCP] = eC_GetTicks64();
    }
 
 
    void ControlPointEnd(PerfMonControlPoint_t eCP)
    {
        m_SumCP[eCP] = m_SumCP[eCP] + (eC_GetTicks64() - m_StartCP[eCP]);
        ++m_CountCP[eCP];
    }
 
    void CalcPerfMeasures();
 
 
    void SetNumOfUserEntries(eC_UInt uiNumOfUserEntries);
 
    eC_UInt GetNumOfUserEntries() { return m_uiNumOfUsedUserEntries; }
 
 
    void SetCountLog(eC_Bool bCountLog) { m_bCountLog = bCountLog; }
 
    void SetCyclesPerLog(eC_UInt uiCyclesPerLog) { m_uiCyclesPerLog = uiCyclesPerLog; }
 
    void Reset();
 
    void Enable() { m_bActive = true; }
 
    void Disable() { m_bActive = false; }
 
    void SetLogMode(const LogMode_t eLogMode) { m_eLogMode = eLogMode; }
 
    void SetCallback(PerfMonCallback_t pCallback) { m_pCallback = pCallback; }
 
    void SetFileHandle(FILE* pFileHandle) { m_pFileHandle = pFileHandle; }
 
private:
    CGUIPerfMon();
 
    virtual ~CGUIPerfMon();
 
    CGUIPerfMon(const CGUIPerfMon& kSource);
 
    CGUIPerfMon& operator=(const CGUIPerfMon& kSource);
 
    eC_UInt GetNumOfEntries();
 
    void WriteToFile(const eC_String& rkTraceString);
 
private:
    static CGUIPerfMon* ms_pkInstance; 
 
    eC_Time64 m_StartCP[eNumOfElements]; 
    eC_Time64 m_EndCP[eNumOfElements]; 
    eC_Time64 m_SumCP[eNumOfElements]; 
    eC_UInt   m_CountCP[eNumOfElements]; 
 
    eC_UInt m_uiNumOfUsedUserEntries; 
 
    eC_Bool m_bCountLog; 
    eC_Bool m_bWriteLogFile; 
 
    eC_UInt m_uiCyclesPerLog; 
    eC_UInt m_uiCycleCount; 
 
    eC_Bool m_bActive; 
 
    LogMode_t m_eLogMode; 
 
    FILE* m_pFileHandle; 
 
    PerfMonCallback_t m_pCallback; 
    eC_UInt* m_pCallbackValues;
};
#endif //GUIPERFMON
#endif /* DOXYGEN */
#endif