A timer designed for diagnostics. More...

#include <util/util.hh>

Inheritance diagram for gazebo::util::DiagnosticTimer:

Public Member Functions
	DiagnosticTimer (const std::string &_name)
	Constructor. More...

virtual	~DiagnosticTimer ()
	Destructor. More...

const std::string	GetName () const GAZEBO_DEPRECATED(7.0)
	Get the name of the timer. More...

void	Lap (const std::string &_prefix)
	Output a lap time. More...

const std::string	Name () const
	Get the name of the timer. More...

virtual void	Start ()
	Start the timer. More...

virtual void	Stop ()
	Stop the timer. More...

Public Member Functions inherited from gazebo::common::Timer
	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...

Detailed Description

A timer designed for diagnostics.

Constructor & Destructor Documentation

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

Constructor.

Parameters

[in] _name Name of the timer

virtual gazebo::util::DiagnosticTimer::~DiagnosticTimer ( )

virtual

Destructor.

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

Get the name of the timer.

void gazebo::util::DiagnosticTimer::Lap ( const std::string & _prefix )

Output a lap time.

Parameters

[in] _prefix Annotation to output with the elapsed time.

const std::string gazebo::util::DiagnosticTimer::Name ( ) const

Get the name of the timer.

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

virtual

Start the timer.

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

virtual

Stop the timer.

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