CrystalSpace

Public API Reference

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

csUtilDebugHelper Class Reference

This is a class that does unit testing (and other debug stuff) for some of csutil classes. More...

#include <utiltest.h>

Inheritance diagram for csUtilDebugHelper:

iDebugHelper iBase List of all members.

Public Methods

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

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

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

virtual csTicks Benchmark (int)
 Perform a benchmark. More...

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

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

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


Detailed Description

This is a class that does unit testing (and other debug stuff) for some of csutil classes.

Definition at line 28 of file utiltest.h.


Member Function Documentation

virtual csTicks csUtilDebugHelper::Benchmark int    [inline, virtual]
 

Perform a benchmark.

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

Implements iDebugHelper.

Definition at line 44 of file utiltest.h.

References csTicks.

virtual bool csUtilDebugHelper::DebugCommand const char *    [inline, virtual]
 

Perform a debug command as defined by the module itself.

Returns 'false' if the command was not recognized.

Implements iDebugHelper.

Definition at line 55 of file utiltest.h.

virtual void csUtilDebugHelper::Dump iGraphics3D   [inline, virtual]
 

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

Implements iDebugHelper.

Definition at line 52 of file utiltest.h.

virtual csPtr<iString> csUtilDebugHelper::Dump   [inline, virtual]
 

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.

Implements iDebugHelper.

Definition at line 48 of file utiltest.h.

virtual int csUtilDebugHelper::GetSupportedTests   const [inline, 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:

Implements iDebugHelper.

Definition at line 35 of file utiltest.h.

References CS_DBGHELP_UNITTEST.

virtual csPtr<iString> csUtilDebugHelper::StateTest   [inline, virtual]
 

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.

Implements iDebugHelper.

Definition at line 40 of file utiltest.h.

virtual csPtr<iString> csUtilDebugHelper::UnitTest   [virtual]
 

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.

Implements iDebugHelper.


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