Public Member Functions | Public Attributes | List of all members
ros::TimerOptions Struct Reference

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

#include <timer_options.h>

Public Member Functions

 TimerOptions ()
 TimerOptions (Duration _period, const TimerCallback &_callback, CallbackQueueInterface *_queue, bool oneshot=false, bool autostart=true)

Public Attributes

bool autostart
TimerCallback callback
 The callback to call. More...
 Queue to add callbacks to. If NULL, the global callback queue will be used. More...
bool oneshot
Duration period
 The period to call the callback at. More...
VoidConstPtr tracked_object

Detailed Description

Encapsulates all options available for starting a timer.

Definition at line 40 of file timer_options.h.

Constructor & Destructor Documentation

◆ TimerOptions() [1/2]

ros::TimerOptions::TimerOptions ( )

Definition at line 42 of file timer_options.h.

◆ TimerOptions() [2/2]

ros::TimerOptions::TimerOptions ( Duration  _period,
const TimerCallback _callback,
CallbackQueueInterface _queue,
bool  oneshot = false,
bool  autostart = true 

Definition at line 53 of file timer_options.h.

Member Data Documentation

◆ autostart

bool ros::TimerOptions::autostart

Definition at line 78 of file timer_options.h.

◆ callback

TimerCallback ros::TimerOptions::callback

The callback to call.

Definition at line 63 of file timer_options.h.

◆ callback_queue

CallbackQueueInterface* ros::TimerOptions::callback_queue

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

Definition at line 65 of file timer_options.h.

◆ oneshot

bool ros::TimerOptions::oneshot

Definition at line 77 of file timer_options.h.

◆ period

Duration ros::TimerOptions::period

The period to call the callback at.

Definition at line 62 of file timer_options.h.

◆ tracked_object

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 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 75 of file timer_options.h.

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

Author(s): Morgan Quigley, Josh Faust, Brian Gerkey, Troy Straszheim, Dirk Thomas , Jacob Perron
autogenerated on Thu Nov 23 2023 04:01:45