iDebugHelper Struct Reference
[Utilities]
Some object that wants to implement unit testing, debugging and/or benchmarking can implement this interface. More...
#include <iutil/dbghelp.h>
Public Member Functions | |
| virtual csTicks | Benchmark (int num_iterations)=0 |
| Perform a benchmark. | |
| virtual bool | DebugCommand (const char *cmd)=0 |
| Perform a debug command as defined by the module itself. | |
| virtual void | Dump (iGraphics3D *g3d)=0 |
| Do a graphical dump of the current state of this object. | |
| virtual csPtr< iString > | Dump ()=0 |
| Do a text dump of the current state of this object. | |
| virtual int | GetSupportedTests () const =0 |
| Return a bit field indicating what types of functions this specific unit test implementation supports. | |
| virtual csPtr< iString > | StateTest ()=0 |
| Perform a state test. | |
Detailed Description
Some object that wants to implement unit testing, debugging and/or benchmarking can implement this interface.
Definition at line 52 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 csKDTree, CS::Geometry::KDTree, csTiledCoverageBuffer, and csGraphics2D.
| 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 csKDTree, CS::Geometry::KDTree, csTiledCoverageBuffer, csGraphics2D, and csGraphics2DGLCommon.
| virtual void iDebugHelper::Dump | ( | iGraphics3D * | g3d | ) | [pure virtual] |
Do a graphical dump of the current state of this object.
Implemented in csKDTree, CS::Geometry::KDTree, csTiledCoverageBuffer, and csGraphics2D.
Do a text dump of the current state of this object.
Returns 0 if not supported or else a string which you should DecRef() after use.
Implemented in csKDTree, CS::Geometry::KDTree, csTiledCoverageBuffer, and csGraphics2D.
| 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 csKDTree, CS::Geometry::KDTree, csTiledCoverageBuffer, and csGraphics2D.
Perform a state test.
This function will test if the current state of the object is ok. It will return 0 if it is ok. Otherwise an iString is returned containing some information about the errors. DecRef() this returned string after using it.
Implemented in csKDTree, CS::Geometry::KDTree, csTiledCoverageBuffer, and csGraphics2D.
The documentation for this struct was generated from the following file:
- iutil/dbghelp.h
Generated for Crystal Space 2.0 by doxygen 1.6.1