ros::SteadyTimer Class Reference

Manages a steady-clock timer callback. More...

#include <steady_timer.h>

Classes
class	Impl

Public Member Functions
bool	hasPending ()
	Returns whether or not the timer has any pending events to call. More...
bool	isValid ()
	operator void * ()
bool	operator!= (const SteadyTimer &rhs)
bool	operator< (const SteadyTimer &rhs)
bool	operator== (const SteadyTimer &rhs)
void	setPeriod (const WallDuration &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...
	SteadyTimer ()
	SteadyTimer (const SteadyTimer &rhs)
void	stop ()
	Stop the timer. Once this call returns, no more callbacks will be called. Does nothing if the timer is already stopped. More...
	~SteadyTimer ()

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

Private Member Functions
	SteadyTimer (const SteadyTimerOptions &ops)

Private Attributes
ImplPtr	impl_

Friends
class	NodeHandle

Detailed Description

Manages a steady-clock timer callback.

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

Definition at line 46 of file steady_timer.h.

Member Typedef Documentation

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

private

Definition at line 117 of file steady_timer.h.

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

private

Definition at line 118 of file steady_timer.h.

Constructor & Destructor Documentation

ros::SteadyTimer::SteadyTimer ( )

inline

Definition at line 49 of file steady_timer.h.

ros::SteadyTimer::SteadyTimer

(

const SteadyTimer &

rhs

)

Definition at line 183 of file steady_timer.cpp.

ros::SteadyTimer::~SteadyTimer

(

)

Definition at line 188 of file steady_timer.cpp.

ros::SteadyTimer::SteadyTimer ( const SteadyTimerOptions &  ops )

private

Definition at line 172 of file steady_timer.cpp.

Member Function Documentation

bool ros::SteadyTimer::hasPending

(

)

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

Definition at line 208 of file steady_timer.cpp.

bool ros::SteadyTimer::isValid ( )

inline

Definition at line 73 of file steady_timer.h.

ros::SteadyTimer::operator void * ( )

inline

Definition at line 74 of file steady_timer.h.

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

inline

Definition at line 86 of file steady_timer.h.

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

inline

Definition at line 76 of file steady_timer.h.

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

inline

Definition at line 81 of file steady_timer.h.

void ros::SteadyTimer::setPeriod	(	const WallDuration &	period,
		bool	reset = true
	)

Set the period of this timer.

Definition at line 218 of file steady_timer.cpp.

void ros::SteadyTimer::start

(

)

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

Definition at line 192 of file steady_timer.cpp.

void ros::SteadyTimer::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 200 of file steady_timer.cpp.

Friends And Related Function Documentation

friend class NodeHandle

friend

Definition at line 122 of file steady_timer.h.

Member Data Documentation

ImplPtr ros::SteadyTimer::impl_

private

Definition at line 120 of file steady_timer.h.

---

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

• steady_timer.h
• steady_timer.cpp