Gizmo3D

gzPerformance.h File Reference

Performance measurement functionality for Gizmo3D. More...

#include "gzBase.h"
#include "gzThread.h"
#include "gzReference.h"

Go to the source code of this file.

Classes

class  gzSectionResult
class  gzSectionInfo
class  gzPerformanceBody
class  gzPerformanceMonitorInterface
class  gzMonitorBody

Defines

#define GZ_INSTRUMENT_AUTO
 Defines for instrumentation that is active during GZ_INSTRUMENT_CODE.
#define GZ_INSTRUMENT_NAME(x)
#define GZ_ENTER_PERFORMANCE_SECTION(x)
#define GZ_LEAVE_PERFORMANCE_SECTION
#define GZ_MONITOR_AUTO
#define GZ_MONITOR_NAME(x)
#define GZ_ENTER_MONITOR(x)
#define GZ_LEAVE_MONITOR(x)
#define GZ_ADD_MONITOR_VALUE(x, y)

Enumerations

enum  gzPerformanceDumpFlags {
  GZ_PERF_DUMP_RUNNING = (1<<0), GZ_PERF_DUMP_STOPPED = (1<<1), GZ_PERF_DUMP_ACCUMULATED_SECTIONS = (1<<2), GZ_PERF_DUMP_HIERARCHICAL_SECTIONS = (1<<3),
  GZ_PERF_DUMP_ALL = 0xFFFFFFFFUL
}

Functions

 GZ_USE_BIT_LOGIC (gzPerformanceDumpFlags)
gzVoid gzEnterPerformanceSection (const gzString &sectionName)
gzVoid gzLeavePerformanceSection ()
gzVoid gzStartPerformanceThread ()
gzVoid gzStopPerformanceThread ()
gzVoid gzEnablePerformanceSections (gzBool on=TRUE)
gzVoid gzDumpPerformanceInfo (gzPerformanceDumpFlags dumpFlags=GZ_PERF_DUMP_ALL)
gzString gzCreatePerfLineInfo (const char *file, gzULong line)
gzSectionResult gzGetSectionResult (const gzString &sectionName, gzULong threadID=gzThread::getThreadID())
gzVoid gzGetAllPerformanceSections (gzRefList< gzSectionInfo > &perfSecList, gzULong threadID=gzThread::getThreadID())
gzVoid gzClearPerformanceSection (const gzString &name=GZ_EMPTY_STRING, gzULong threadID=gzThread::getThreadID())
gzVoid gzEnterMonitor (const gzString &monitor)
gzVoid gzLeaveMonitor (const gzString &monitor)
gzVoid gzAddMonitorValue (const gzString &monitor, const gzDouble &value, const gzDouble *time=NULL)


Detailed Description

Performance measurement functionality for Gizmo3D.

As Gizmo3D is plattform independant, we need a way to do performance measurement independantly of the HW platform. By using this module, we can measure the time spend in code snippets etc. and get info about bottlenecks etc.

Definition in file gzPerformance.h.


Define Documentation

#define GZ_ADD_MONITOR_VALUE x,
 ) 
 

Definition at line 250 of file gzPerformance.h.

#define GZ_ENTER_MONITOR  ) 
 

Definition at line 248 of file gzPerformance.h.

#define GZ_ENTER_PERFORMANCE_SECTION  ) 
 

Definition at line 243 of file gzPerformance.h.

#define GZ_INSTRUMENT_AUTO
 

Defines for instrumentation that is active during GZ_INSTRUMENT_CODE.

Definition at line 241 of file gzPerformance.h.

#define GZ_INSTRUMENT_NAME  ) 
 

Definition at line 242 of file gzPerformance.h.

#define GZ_LEAVE_MONITOR  ) 
 

Definition at line 249 of file gzPerformance.h.

#define GZ_LEAVE_PERFORMANCE_SECTION
 

Definition at line 244 of file gzPerformance.h.

#define GZ_MONITOR_AUTO
 

Definition at line 246 of file gzPerformance.h.

#define GZ_MONITOR_NAME  ) 
 

Definition at line 247 of file gzPerformance.h.


Enumeration Type Documentation

enum gzPerformanceDumpFlags
 

Enumerator:
GZ_PERF_DUMP_RUNNING 
GZ_PERF_DUMP_STOPPED 
GZ_PERF_DUMP_ACCUMULATED_SECTIONS 
GZ_PERF_DUMP_HIERARCHICAL_SECTIONS 
GZ_PERF_DUMP_ALL 

Definition at line 35 of file gzPerformance.h.


Function Documentation

GZ_USE_BIT_LOGIC gzPerformanceDumpFlags   ) 
 

gzVoid gzAddMonitorValue const gzString monitor,
const gzDouble value,
const gzDouble time = NULL
 

gzVoid gzClearPerformanceSection const gzString name = GZ_EMPTY_STRING,
gzULong  threadID = gzThread::getThreadID()
 

gzString gzCreatePerfLineInfo const char *  file,
gzULong  line
 

gzVoid gzDumpPerformanceInfo gzPerformanceDumpFlags  dumpFlags = GZ_PERF_DUMP_ALL  ) 
 

gzVoid gzEnablePerformanceSections gzBool  on = TRUE  ) 
 

gzVoid gzEnterMonitor const gzString monitor  ) 
 

gzVoid gzEnterPerformanceSection const gzString sectionName  ) 
 

gzVoid gzGetAllPerformanceSections gzRefList< gzSectionInfo > &  perfSecList,
gzULong  threadID = gzThread::getThreadID()
 

gzSectionResult gzGetSectionResult const gzString sectionName,
gzULong  threadID = gzThread::getThreadID()
 

gzVoid gzLeaveMonitor const gzString monitor  ) 
 

gzVoid gzLeavePerformanceSection  ) 
 

gzVoid gzStartPerformanceThread  ) 
 

gzVoid gzStopPerformanceThread  ) 
 


Documentation for Gizmo3D generated at Wed Feb 20 11:54:13 2008 by   Saab Training Systems AB, ¸ (c) 2003-and beyond