roscpp: ros::TimerManager< T, D, E > Class Template Reference

#include <internal_timer_manager.h>

Classes
struct	TimerInfo

class	TimerQueueCallback

Public Member Functions
int32_t	add (const D &period, const boost::function< void(const E &)> &callback, CallbackQueueInterface *callback_queue, const VoidConstPtr &tracked_object, bool oneshot)

bool	hasPending (int32_t handle)

void	remove (int32_t handle)

void	setPeriod (int32_t handle, const D &period, bool reset=true)

	TimerManager ()

	~TimerManager ()

Static Public Member Functions
static TimerManager &	global ()

Private Types
typedef std::list< int32_t >	L_int32

typedef boost::shared_ptr< TimerInfo >	TimerInfoPtr

typedef boost::weak_ptr< TimerInfo >	TimerInfoWPtr

typedef std::vector< TimerInfoPtr >	V_TimerInfo

Private Member Functions
TimerInfoPtr	findTimer (int32_t handle)

void	schedule (const TimerInfoPtr &info)

void	threadFunc ()

void	updateNext (const TimerInfoPtr &info, const T &current_time)

bool	waitingCompare (int32_t lhs, int32_t rhs)

Private Attributes
uint32_t	id_counter_

boost::mutex	id_mutex_

volatile bool	new_timer_

bool	quit_

boost::thread	thread_

bool	thread_started_

V_TimerInfo	timers_

ros::internal::condition_variable_monotonic	timers_cond_

boost::mutex	timers_mutex_

L_int32	waiting_

boost::mutex	waiting_mutex_

Detailed Description

template<class T, class D, class E>
class ros::TimerManager< T, D, E >

Definition at line 38 of file internal_timer_manager.h.

Member Typedef Documentation

◆ L_int32

template<class T , class D , class E >

typedef std::list<int32_t> ros::TimerManager< T, D, E >::L_int32

private

Definition at line 105 of file timer_manager.h.

◆ TimerInfoPtr

template<class T , class D , class E >

typedef boost::shared_ptr<TimerInfo> ros::TimerManager< T, D, E >::TimerInfoPtr

private

Definition at line 101 of file timer_manager.h.

◆ TimerInfoWPtr

template<class T , class D , class E >

typedef boost::weak_ptr<TimerInfo> ros::TimerManager< T, D, E >::TimerInfoWPtr

private

Definition at line 102 of file timer_manager.h.

◆ V_TimerInfo

template<class T , class D , class E >

typedef std::vector<TimerInfoPtr> ros::TimerManager< T, D, E >::V_TimerInfo

private

Definition at line 103 of file timer_manager.h.

Constructor & Destructor Documentation

◆ TimerManager()

template<class T , class D , class E >

ros::TimerManager< T, D, E >::TimerManager ( )

Definition at line 234 of file timer_manager.h.

◆ ~TimerManager()

template<class T , class D , class E >

ros::TimerManager< T, D, E >::~TimerManager ( )

Definition at line 239 of file timer_manager.h.

Member Function Documentation

◆ add()

template<class T , class D , class E >

int32_t ros::TimerManager< T, D, E >::add	(	const D &	period,
		const boost::function< void(const E &)> &	callback,
		CallbackQueueInterface *	callback_queue,
		const VoidConstPtr &	tracked_object,
		bool	oneshot
	)

Definition at line 306 of file timer_manager.h.

◆ findTimer()

template<class T , class D , class E >

TimerManager< T, D, E >::TimerInfoPtr ros::TimerManager< T, D, E >::findTimer ( int32_t handle )

private

Definition at line 266 of file timer_manager.h.

◆ global()

template<class T , class D , class E >

static TimerManager& ros::TimerManager< T, D, E >::global ( )

inlinestatic

Definition at line 117 of file timer_manager.h.

◆ hasPending()

template<class T , class D , class E >

bool ros::TimerManager< T, D, E >::hasPending ( int32_t handle )

Definition at line 282 of file timer_manager.h.

◆ remove()

template<class T , class D , class E >

void ros::TimerManager< T, D, E >::remove ( int32_t handle )

Definition at line 355 of file timer_manager.h.

◆ schedule()

template<class T , class D , class E >

void ros::TimerManager< T, D, E >::schedule ( const TimerInfoPtr & info )

private

Definition at line 396 of file timer_manager.h.

◆ setPeriod()

template<class T , class D , class E >

void ros::TimerManager< T, D, E >::setPeriod	(	int32_t	handle,
		const D &	period,
		bool	reset = `true`
	)

Definition at line 446 of file timer_manager.h.

◆ threadFunc()

template<class T , class D , class E >

void ros::TimerManager< T, D, E >::threadFunc ( )

private

Definition at line 493 of file timer_manager.h.

◆ updateNext()

template<class T , class D , class E >

void ros::TimerManager< T, D, E >::updateNext	(	const TimerInfoPtr &	info,
		const T &	current_time
	)

private

Definition at line 419 of file timer_manager.h.

◆ waitingCompare()

template<class T , class D , class E >

bool ros::TimerManager< T, D, E >::waitingCompare	(	int32_t	lhs,
		int32_t	rhs
	)

private

Definition at line 253 of file timer_manager.h.

Member Data Documentation

◆ id_counter_

template<class T , class D , class E >

uint32_t ros::TimerManager< T, D, E >::id_counter_

private

Definition at line 139 of file timer_manager.h.

◆ id_mutex_

template<class T , class D , class E >

boost::mutex ros::TimerManager< T, D, E >::id_mutex_

private

Definition at line 140 of file timer_manager.h.

◆ new_timer_

template<class T , class D , class E >

volatile bool ros::TimerManager< T, D, E >::new_timer_

private

Definition at line 134 of file timer_manager.h.

◆ quit_

template<class T , class D , class E >

bool ros::TimerManager< T, D, E >::quit_

private

Definition at line 146 of file timer_manager.h.

◆ thread_

template<class T , class D , class E >

boost::thread ros::TimerManager< T, D, E >::thread_

private

Definition at line 144 of file timer_manager.h.

◆ thread_started_

template<class T , class D , class E >

bool ros::TimerManager< T, D, E >::thread_started_

private

Definition at line 142 of file timer_manager.h.

◆ timers_

template<class T , class D , class E >

V_TimerInfo ros::TimerManager< T, D, E >::timers_

private

Definition at line 131 of file timer_manager.h.

◆ timers_cond_

template<class T , class D , class E >

ros::internal::condition_variable_monotonic ros::TimerManager< T, D, E >::timers_cond_

private

Definition at line 133 of file timer_manager.h.

◆ timers_mutex_

template<class T , class D , class E >

boost::mutex ros::TimerManager< T, D, E >::timers_mutex_

private

Definition at line 132 of file timer_manager.h.

◆ waiting_

template<class T , class D , class E >

L_int32 ros::TimerManager< T, D, E >::waiting_

private

Definition at line 137 of file timer_manager.h.

◆ waiting_mutex_

template<class T , class D , class E >

boost::mutex ros::TimerManager< T, D, E >::waiting_mutex_

private

Definition at line 136 of file timer_manager.h.

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

roscpp
Author(s): Morgan Quigley, Josh Faust, Brian Gerkey, Troy Straszheim, Dirk Thomas
autogenerated on Mon Feb 28 2022 23:33:27