Public Member Functions | Friends | List of all members
gazebo::common::Timer Class Reference

A timer class, used to time things in real world walltime. More...

#include <common/common.hh>

Inheritance diagram for gazebo::common::Timer:
Inheritance graph
[legend]

Public Member Functions

 Timer ()
 Default constructor. More...
 
 Timer (const Time &_maxTime, const bool _countdown=true)
 Countdown 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...
 
void Reset ()
 Reset the timer. More...
 
virtual void Start ()
 Start the timer. More...
 
virtual void Stop ()
 Stop the timer. More...
 

Friends

std::ostream & operator<< (std::ostream &out, const gazebo::common::Timer &t)
 Stream operator friendly. More...
 

Detailed Description

A timer class, used to time things in real world walltime.

Constructor & Destructor Documentation

gazebo::common::Timer::Timer ( )

Default constructor.

gazebo::common::Timer::Timer ( const Time _maxTime,
const bool  _countdown = true 
)

Countdown constructor.

Parameters
[in]_maxTimeThe time to count down from.
[in]_countdown.Whether or not to count down. True by default if this constructor is used.
virtual gazebo::common::Timer::~Timer ( )
virtual

Destructor.

Member Function Documentation

Time gazebo::common::Timer::GetElapsed ( ) const

Get the elapsed time.

Returns
The time
bool gazebo::common::Timer::GetRunning ( ) const

Returns true if the timer is running.

Returns
Tue if the timer has been started and not stopped.
void gazebo::common::Timer::Reset ( )

Reset the timer.

virtual void gazebo::common::Timer::Start ( )
virtual

Start the timer.

Reimplemented in gazebo::util::DiagnosticTimer.

virtual void gazebo::common::Timer::Stop ( )
virtual

Stop the timer.

Reimplemented in gazebo::util::DiagnosticTimer.

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  out,
const gazebo::common::Timer t 
)
friend

Stream operator friendly.


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