All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | List of all members
gazebo::util::DiagnosticTimer Class Reference

A timer designed for diagnostics. More...

#include <util/util.hh>

Inheritance diagram for gazebo::util::DiagnosticTimer:
Inheritance graph
[legend]
Collaboration diagram for gazebo::util::DiagnosticTimer:
Collaboration graph
[legend]

Public Member Functions

 DiagnosticTimer (const std::string &_name)
 Constructor. More...
 
virtual ~DiagnosticTimer ()
 Destructor. More...
 
const std::string GetName () const
 Get the name of the timer. More...
 
void Lap (const std::string &_prefix)
 Output a lap time. More...
 
virtual void Start ()
 Start the timer. More...
 
virtual void Stop ()
 Stop the timer. More...
 
- Public Member Functions inherited from gazebo::common::Timer
 Timer ()
 Constructor. More...
 
virtual ~Timer ()
 Destructor. More...
 
Time GetElapsed () const
 Get the elapsed time. More...
 
bool GetRunning () const
 Returns true if the timer is running. More...
 

Detailed Description

A timer designed for diagnostics.

Constructor & Destructor Documentation

gazebo::util::DiagnosticTimer::DiagnosticTimer ( const std::string &  _name)

Constructor.

Parameters
[in]_nameName of the timer
virtual gazebo::util::DiagnosticTimer::~DiagnosticTimer ( )
virtual

Destructor.

Member Function Documentation

const std::string gazebo::util::DiagnosticTimer::GetName ( ) const
inline

Get the name of the timer.

Returns
The name of timer
void gazebo::util::DiagnosticTimer::Lap ( const std::string &  _prefix)

Output a lap time.

Parameters
[in]_prefixAnnotation to output with the elapsed time.
virtual void gazebo::util::DiagnosticTimer::Start ( )
virtual

Start the timer.

Reimplemented from gazebo::common::Timer.

virtual void gazebo::util::DiagnosticTimer::Stop ( )
virtual

Stop the timer.

Reimplemented from gazebo::common::Timer.


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