CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

iDebugHelper Struct Reference
[Utilities]

Some object that wants to implement unit testing, debugging and/or benchmarking can implement this interface. More...

#include <dbghelp.h>

Inheritance diagram for iDebugHelper:

iBase csGeomDebugHelper csUtilDebugHelper List of all members.

Public Methods

virtual int GetSupportedTests () const=0
 Return a bit field indicating what types of functions this specific unit test implementation supports. More...

virtual csPtr< iStringUnitTest ()=0
 Perform a unit test. More...

virtual csPtr< iStringStateTest ()=0
 Perform a state test. More...

virtual csTicks Benchmark (int num_iterations)=0
 Perform a benchmark. More...

virtual csPtr< iStringDump ()=0
 Do a text dump of the current state of this object. More...

virtual void Dump (iGraphics3D *g3d)=0
 Do a graphical dump of the current state of this object. More...

virtual bool DebugCommand (const char *cmd)=0
 Perform a debug command as defined by the module itself. More...


Detailed Description

Some object that wants to implement unit testing, debugging and/or benchmarking can implement this interface.

Definition at line 62 of file dbghelp.h.


Member Function Documentation

virtual csTicks iDebugHelper::Benchmark int    num_iterations [pure virtual]
 

Perform a benchmark.

This function will return a number indicating how long the benchmark lasted in milliseconds.

Implemented in csGeomDebugHelper.

virtual bool iDebugHelper::DebugCommand const char *    cmd [pure virtual]
 

Perform a debug command as defined by the module itself.

Returns 'false' if the command was not recognized.

Implemented in csGeomDebugHelper.

virtual void iDebugHelper::Dump iGraphics3D   g3d [pure virtual]
 

Do a graphical dump of the current state of this object.

Implemented in csGeomDebugHelper.

virtual csPtr<iString> iDebugHelper::Dump   [pure virtual]
 

Do a text dump of the current state of this object.

Returns NULL if not supported or else a string which you should DecRef() after use.

Implemented in csGeomDebugHelper.

virtual int iDebugHelper::GetSupportedTests   const [pure virtual]
 

Return a bit field indicating what types of functions this specific unit test implementation supports.

This will return a combination of the CS_DBGHELP_... flags:

Implemented in csGeomDebugHelper.

virtual csPtr<iString> iDebugHelper::StateTest   [pure virtual]
 

Perform a state test.

This function will test if the current state of the object is ok. It will return NULL if it is ok. Otherwise an iString is returned containing some information about the errors. DecRef() this returned string after using it.

Implemented in csGeomDebugHelper.

virtual csPtr<iString> iDebugHelper::UnitTest   [pure virtual]
 

Perform a unit test.

This function will try to test as much as possible of the given module. This function returns NULL if the test succeeded. Otherwise an iString is returned containing some information about the errors. DecRef() this returned string after using it.

Implemented in csGeomDebugHelper.


The documentation for this struct was generated from the following file:
Generated for Crystal Space by doxygen 1.2.14