ros::WallTimerOptions Struct Reference

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

#include <wall_timer_options.h>

List of all members.

Public Member Functions

 WallTimerOptions (WallDuration _period, const WallTimerCallback &_callback, CallbackQueueInterface *_queue, bool oneshot=false)
 WallTimerOptions ()

Public Attributes

WallTimerCallback callback
 The callback to call.
CallbackQueueInterfacecallback_queue
 Queue to add callbacks to. If NULL, the global callback queue will be used.
bool oneshot
WallDuration 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 wall_timer_options.h.


Constructor & Destructor Documentation

ros::WallTimerOptions::WallTimerOptions (  )  [inline]

Definition at line 41 of file wall_timer_options.h.

ros::WallTimerOptions::WallTimerOptions ( WallDuration  _period,
const WallTimerCallback _callback,
CallbackQueueInterface _queue,
bool  oneshot = false 
) [inline]

Definition at line 52 of file wall_timer_options.h.


Member Data Documentation

The callback to call.

Definition at line 60 of file wall_timer_options.h.

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

Definition at line 62 of file wall_timer_options.h.

Definition at line 74 of file wall_timer_options.h.

The period to call the callback at.

Definition at line 59 of file wall_timer_options.h.

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 wall_timer_options.h.


The documentation for this struct was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


roscpp
Author(s): Morgan Quigley mquigley@cs.stanford.edu, Josh Faust jfaust@willowgarage.com, Brian Gerkey gerkey@willowgarage.com
autogenerated on Fri Jan 11 10:08:42 2013