A diagnostic manager class. More...

#include <util/util.hh>

Inheritance diagram for gazebo::util::DiagnosticManager:

Public Member Functions
std::string	GetLabel (int _index) const
	Get a label for a timer. More...

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

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

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

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

void	Init (const std::string &_worldName)
	Initialize to report diagnostics about a world. 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...

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

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

Additional Inherited Members
Static Public Member Functions inherited from SingletonT< DiagnosticManager >
static DiagnosticManager *	Instance ()
	Get an instance of the singleton. More...

Protected Member Functions inherited from SingletonT< DiagnosticManager >
	SingletonT ()
	Constructor. More...

virtual	~SingletonT ()
	Destructor. More...

Detailed Description

A diagnostic manager class.

Member Function Documentation

std::string gazebo::util::DiagnosticManager::GetLabel ( int _index ) const

Get a label for a timer.

Parameters

[in] _index Index of a timer instance

Returns: Label of the specified timer

boost::filesystem::path gazebo::util::DiagnosticManager::GetLogPath ( ) const

Get the path in which logs are stored.

Returns: The path in which logs are stored.

common::Time gazebo::util::DiagnosticManager::GetTime ( 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 gazebo::util::DiagnosticManager::GetTime ( 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 gazebo::util::DiagnosticManager::GetTimerCount ( ) const

Get the number of timers.

Returns: The number of timers

void gazebo::util::DiagnosticManager::Init ( const std::string & _worldName )

Initialize to report diagnostics about a world.

Parameters

[in] _worldName Name of the world.

void gazebo::util::DiagnosticManager::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.

void gazebo::util::DiagnosticManager::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 gazebo::util::DiagnosticManager::StopTimer ( const std::string & _name )

Stop a currently running timer.

Parameters

[in] _name Name of the timer to stop.

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

util/Diagnostics.hh

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation