A diagnostic manager class. More...

#include <util/util.hh>

Inherits SingletonT< DiagnosticManager >.

Public Member Functions
void	Init (const std::string &_worldName)
	Initialize to report diagnostics about a world. More...

std::string	Label (const int _index) const
	Get a label for a timer. More...

void	Lap (const std::string &_name, const std::string &_prefix)
	Output the current elapsed time of an active timer with a prefix string. More...

boost::filesystem::path	LogPath () const
	Get the path in which logs are stored. More...

void	StartTimer (const std::string &_name)
	Start a new timer instance. More...

void	StopTimer (const std::string &_name)
	Stop a currently running timer. More...

common::Time	Time (const int _index) const
	Get the time of a timer instance. More...

common::Time	Time (const std::string &_label) const
	Get a time based on a label. More...

int	TimerCount () const
	Get the number of timers. More...

Static Public Member Functions
static DiagnosticManager *	Instance ()
	Get an instance of the singleton. More...

Detailed Description

A diagnostic manager class.

Member Function Documentation

void Init ( const std::string & _worldName )

Initialize to report diagnostics about a world.

Parameters

[in] _worldName Name of the world.

static DiagnosticManager * Instance ( )

inlinestaticinherited

Get an instance of the singleton.

std::string Label ( const int _index ) const

Get a label for a timer.

Parameters

[in] _index Index of a timer instance

Returns: Label of the specified timer

void Lap	(	const std::string &	_name,
		const std::string &	_prefix
	)

Output the current elapsed time of an active timer with a prefix string.

This also resets the timer and keeps it running.

Parameters

[in]	_name	Name of the timer to access.
[in]	_prefix	Informational string that is output with the elapsed time.

boost::filesystem::path LogPath ( ) const

Get the path in which logs are stored.

Returns: The path in which logs are stored.

void StartTimer ( const std::string & _name )

Start a new timer instance.

Parameters

[in] _name Name of the timer.

Returns: A pointer to the new diagnostic timer

void StopTimer ( const std::string & _name )

Stop a currently running timer.

Parameters

[in] _name Name of the timer to stop.

common::Time Time ( const int _index ) const

Get the time of a timer instance.

Parameters

[in] _index The index of a timer instance

Returns: Time of the specified timer

common::Time Time ( const std::string & _label ) const

Get a time based on a label.

Parameters

[in] _label Name of the timer instance

Returns: Time of the specified timer

int TimerCount ( ) const

Get the number of timers.

Returns: The number of timers

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

Diagnostics.hh

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation