Public Member Functions | List of all members
gazebo::util::DiagnosticManager Class Reference

A diagnostic manager class. More...

#include <util/util.hh>

Inheritance diagram for gazebo::util::DiagnosticManager:
Inheritance graph
[legend]

Public Member Functions

std::string GetLabel (int _index) const GAZEBO_DEPRECATED(7.0)
 Get a label for a timer. More...
 
boost::filesystem::path GetLogPath () const GAZEBO_DEPRECATED(7.0)
 Get the path in which logs are stored. More...
 
common::Time GetTime (int _index) const GAZEBO_DEPRECATED(7.0)
 Get the time of a timer instance. More...
 
common::Time GetTime (const std::string &_label) const GAZEBO_DEPRECATED(7.0)
 Get a time based on a label. More...
 
int GetTimerCount () const GAZEBO_DEPRECATED(7.0)
 Get the number of timers. More...
 
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...
 

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]_indexIndex of a timer instance
Returns
Label of the specified timer
Deprecated:
See Label(const int) const
boost::filesystem::path gazebo::util::DiagnosticManager::GetLogPath ( ) const

Get the path in which logs are stored.

Returns
The path in which logs are stored.
Deprecated:
See LogPath() const
common::Time gazebo::util::DiagnosticManager::GetTime ( int  _index) const

Get the time of a timer instance.

Parameters
[in]_indexThe index of a timer instance
Returns
Time of the specified timer
Deprecated:
See Time(const int) const;
common::Time gazebo::util::DiagnosticManager::GetTime ( const std::string &  _label) const

Get a time based on a label.

Parameters
[in]_labelName of the timer instance
Returns
Time of the specified timer
Deprecated:
See Time(const std::string &_label) const
int gazebo::util::DiagnosticManager::GetTimerCount ( ) const

Get the number of timers.

Returns
The number of timers
Deprecated:
See TimerCount() const
void gazebo::util::DiagnosticManager::Init ( const std::string &  _worldName)

Initialize to report diagnostics about a world.

Parameters
[in]_worldNameName of the world.
std::string gazebo::util::DiagnosticManager::Label ( const int  _index) const

Get a label for a timer.

Parameters
[in]_indexIndex of a timer instance
Returns
Label of the specified timer
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]_nameName of the timer to access.
[in]_prefixInformational string that is output with the elapsed time.
boost::filesystem::path gazebo::util::DiagnosticManager::LogPath ( ) const

Get the path in which logs are stored.

Returns
The path in which logs are stored.
void gazebo::util::DiagnosticManager::StartTimer ( const std::string &  _name)

Start a new timer instance.

Parameters
[in]_nameName 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]_nameName of the timer to stop.
common::Time gazebo::util::DiagnosticManager::Time ( const int  _index) const

Get the time of a timer instance.

Parameters
[in]_indexThe index of a timer instance
Returns
Time of the specified timer
common::Time gazebo::util::DiagnosticManager::Time ( const std::string &  _label) const

Get a time based on a label.

Parameters
[in]_labelName of the timer instance
Returns
Time of the specified timer
int gazebo::util::DiagnosticManager::TimerCount ( ) const

Get the number of timers.

Returns
The number of timers

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