iDebugHelper Struct Reference (Crystal Space 2.0 Public API Reference)

| ## Public API Reference

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

Public Member Functions
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< iString > | Dump ()=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< 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 csTiledCoverageBuffer, csKDTree, CS::Geometry::KDTree, 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 csTiledCoverageBuffer, csKDTree, CS::Geometry::KDTree, csGraphics2D, and csGraphics2DGLCommon.

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.

Implemented in csTiledCoverageBuffer, csKDTree, CS::Geometry::KDTree, and csGraphics2D.

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

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

Implemented in csTiledCoverageBuffer, csKDTree, CS::Geometry::KDTree, 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:

- CS_DBGHELP_BENCHMARK
- CS_DBGHELP_TXTDUMP
- CS_DBGHELP_GFXDUMP
- CS_DBGHELP_STATETEST

Implemented in csTiledCoverageBuffer, csKDTree, CS::Geometry::KDTree, and csGraphics2D.

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.

Implemented in csTiledCoverageBuffer, csKDTree, CS::Geometry::KDTree, and csGraphics2D.

The documentation for this struct was generated from the following file:

- iutil/dbghelp.h