ros::TimerOptions Struct Reference

Encapsulates all options available for starting a timer. More...

#include <timer_options.h>

List of all members.

Public Member Functions
	TimerOptions (Duration _period, const TimerCallback &_callback, CallbackQueueInterface *_queue, bool oneshot=false)
	TimerOptions ()
Public Attributes
TimerCallback	callback
	The callback to call.
CallbackQueueInterface *	callback_queue
	Queue to add callbacks to. If NULL, the global callback queue will be used.
bool	oneshot
Duration	period
	The period to call the callback at.
VoidConstPtr	tracked_object

---

Detailed Description

Encapsulates all options available for starting a timer.

Definition at line 39 of file timer_options.h.

---

Constructor & Destructor Documentation

ros::TimerOptions::TimerOptions

(

)

[inline]

Definition at line 41 of file timer_options.h.

ros::TimerOptions::TimerOptions	(	Duration	_period,
		const TimerCallback &	_callback,
		CallbackQueueInterface *	_queue,
		bool	oneshot = false
	)			[inline]

Definition at line 52 of file timer_options.h.

---

Member Data Documentation

TimerCallback ros::TimerOptions::callback

The callback to call.

Definition at line 60 of file timer_options.h.

CallbackQueueInterface* ros::TimerOptions::callback_queue

Queue to add callbacks to. If NULL, the global callback queue will be used.

Definition at line 62 of file timer_options.h.

bool ros::TimerOptions::oneshot

Definition at line 74 of file timer_options.h.

Duration ros::TimerOptions::period

The period to call the callback at.

Definition at line 59 of file timer_options.h.

VoidConstPtr ros::TimerOptions::tracked_object

A shared pointer to an object to track for these callbacks. If set, the a weak_ptr will be created to this object, and if the reference count goes to 0 the subscriber callbacks will not get called.

Note:

Note that setting this will cause a new reference to be added to the object before the callback, and for it to go out of scope (and potentially be deleted) in the code path (and therefore thread) that the callback is invoked from.

Definition at line 72 of file timer_options.h.

---

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

• timer_options.h