CrystalSpace

Public API Reference

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>

Inheritance diagram for iDebugHelper:

List of all members.

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 csPtr< iStringDump ()=0
 Do a text dump of the current state of this object.
virtual void Dump (iGraphics3D *g3d)=0
 Do a graphical 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< iStringStateTest ()=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.

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.

virtual csPtr<iString> iDebugHelper::Dump (  )  [pure 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.

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

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

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:

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 0 if it is ok. 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:

Generated for Crystal Space 1.4.1 by doxygen 1.7.1