iDebugHelper Struct Reference
Some object that wants to implement unit testing, debugging and/or benchmarking can implement this interface. More...
#include <iutil/dbghelp.h>
Inheritance diagram for iDebugHelper:

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. | |
virtual csPtr< iString > | UnitTest ()=0 |
Perform a unit test. |
Detailed Description
Some object that wants to implement unit testing, debugging and/or benchmarking can implement this interface.
Definition at line 61 of file dbghelp.h.
Member Function Documentation
|
Perform a benchmark. This function will return a number indicating how long the benchmark lasted in milliseconds. |
|
Perform a debug command as defined by the module itself. Returns 'false' if the command was not recognized. |
|
Do a graphical dump of the current state of this object.
|
|
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. |
|
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: |
|
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. |
|
Perform a unit test. This function will try to test as much as possible of the given module. This function returns 0 if the test succeeded. Otherwise an iString is returned containing some information about the errors. DecRef() this returned string after using it. |
The documentation for this struct was generated from the following file:
- iutil/dbghelp.h
Generated for Crystal Space by doxygen 1.4.4