ros::Timer Class Reference

Manages a timer callback. More...

#include <timer.h>

List of all members.

Classes
class	Impl
Public Member Functions
bool	hasPending ()
	Returns whether or not the timer has any pending events to call.
bool	isValid ()
	operator void * ()
bool	operator!= (const Timer &rhs)
bool	operator< (const Timer &rhs)
bool	operator== (const Timer &rhs)
void	setPeriod (const Duration &period)
	Set the period of this timer.
void	start ()
	Start the timer. Does nothing if the timer is already started.
void	stop ()
	Stop the timer. Once this call returns, no more callbacks will be called. Does nothing if the timer is already stopped.
	Timer (const Timer &rhs)
	Timer ()
	~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 44 of file timer.h.

---

Member Typedef Documentation

typedef boost::shared_ptr<Impl> ros::Timer::ImplPtr [private]

Definition at line 104 of file timer.h.

typedef boost::weak_ptr<Impl> ros::Timer::ImplWPtr [private]

Definition at line 105 of file timer.h.

---

Constructor & Destructor Documentation

ros::Timer::Timer

(

)

[inline]

Definition at line 36 of file timer.h.

ros::Timer::Timer

(

const Timer &

rhs

)

Definition at line 102 of file timer.cpp.

ros::Timer::~Timer

(

)

Definition at line 107 of file timer.cpp.

ros::Timer::Timer

(

const TimerOptions &

ops

)

[private]

Definition at line 91 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 127 of file timer.cpp.

bool ros::Timer::isValid

(

)

[inline]

Definition at line 60 of file timer.h.

ros::Timer::operator void *

(

)

[inline]

Definition at line 61 of file timer.h.

bool ros::Timer::operator!=

(

const Timer &

rhs

)

[inline]

Definition at line 73 of file timer.h.

bool ros::Timer::operator<

(

const Timer &

rhs

)

[inline]

Definition at line 63 of file timer.h.

bool ros::Timer::operator==

(

const Timer &

rhs

)

[inline]

Definition at line 68 of file timer.h.

void ros::Timer::setPeriod

(

const Duration &

period

)

Set the period of this timer.

Definition at line 137 of file timer.cpp.

void ros::Timer::start

(

)

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

Definition at line 111 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 119 of file timer.cpp.

---

Friends And Related Function Documentation

friend class NodeHandle [friend]

Definition at line 109 of file timer.h.

---

Member Data Documentation

ImplPtr ros::Timer::impl_ [private]

Definition at line 107 of file timer.h.

---

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

• timer.h
• timer.cpp