ros::Timer Class Reference

Manages a timer callback. More...

#include <timer.h>

Classes
class	Impl

Public Member Functions
bool	hasPending ()
	Returns whether or not the timer has any pending events to call. More...
bool	hasStarted () const
bool	isValid ()
bool	isValid () const
	operator void * ()
bool	operator!= (const Timer &rhs)
bool	operator< (const Timer &rhs)
bool	operator== (const Timer &rhs)
void	setPeriod (const Duration &period, bool reset=true)
	Set the period of this timer. More...
void	start ()
	Start the timer. Does nothing if the timer is already started. More...
void	stop ()
	Stop the timer. Once this call returns, no more callbacks will be called. Does nothing if the timer is already stopped. More...
	Timer ()
	Timer (const Timer &rhs)
	~Timer ()

Private Types
typedef boost::shared_ptr< Impl >	ImplPtr
typedef boost::weak_ptr< Impl >	ImplWPtr

Private Member Functions
	Timer (const TimerOptions &ops)

Private Attributes
ImplPtr	impl_

Friends
class	NodeHandle

Detailed Description

Manages a timer callback.

A Timer should always be created through a call to NodeHandle::createTimer(), or copied from one that was. Once all copies of a specific Timer go out of scope, the callback associated with that handle will stop being called.

Definition at line 46 of file timer.h.

Member Typedef Documentation

typedef boost::shared_ptr<Impl> ros::Timer::ImplPtr

private

Definition at line 122 of file timer.h.

typedef boost::weak_ptr<Impl> ros::Timer::ImplWPtr

private

Definition at line 123 of file timer.h.

Constructor & Destructor Documentation

ros::Timer::Timer ( )

inline

Definition at line 49 of file timer.h.

ros::Timer::Timer

(

const Timer &

rhs

)

Definition at line 112 of file timer.cpp.

ros::Timer::~Timer

(

)

Definition at line 117 of file timer.cpp.

ros::Timer::Timer ( const TimerOptions &  ops )

private

Definition at line 101 of file timer.cpp.

Member Function Documentation

bool ros::Timer::hasPending

(

)

Returns whether or not the timer has any pending events to call.

Definition at line 137 of file timer.cpp.

bool ros::Timer::hasStarted ( ) const

inline

Definition at line 74 of file timer.h.

bool ros::Timer::isValid ( )

inline

Definition at line 75 of file timer.h.

bool ros::Timer::isValid ( ) const

inline

Definition at line 76 of file timer.h.

ros::Timer::operator void * ( )

inline

Definition at line 77 of file timer.h.

bool ros::Timer::operator!= ( const Timer &  rhs )

inline

Definition at line 89 of file timer.h.

bool ros::Timer::operator< ( const Timer &  rhs )

inline

Definition at line 79 of file timer.h.

bool ros::Timer::operator== ( const Timer &  rhs )

inline

Definition at line 84 of file timer.h.

void ros::Timer::setPeriod	(	const Duration &	period,
		bool	reset = true
	)

Set the period of this timer.

Parameters

reset

Whether to reset the timer. If true, timer ignores elapsed time and next cb occurs at now()+period

Definition at line 147 of file timer.cpp.

void ros::Timer::start

(

)

Start the timer. Does nothing if the timer is already started.

Definition at line 121 of file timer.cpp.

void ros::Timer::stop

(

)

Stop the timer. Once this call returns, no more callbacks will be called. Does nothing if the timer is already stopped.

Definition at line 129 of file timer.cpp.

Friends And Related Function Documentation

friend class NodeHandle

friend

Definition at line 127 of file timer.h.

Member Data Documentation

ImplPtr ros::Timer::impl_

private

Definition at line 125 of file timer.h.

---

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

• timer.h
• timer.cpp