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

#include <steady_timer_options.h>

Public Member Functions
	SteadyTimerOptions ()

	SteadyTimerOptions (WallDuration _period, const SteadyTimerCallback &_callback, CallbackQueueInterface *_queue, bool oneshot=false, bool autostart=true)

Public Attributes
bool	autostart

SteadyTimerCallback	callback
	The callback to call. More...

CallbackQueueInterface *	callback_queue
	Queue to add callbacks to. If NULL, the global callback queue will be used. More...

bool	oneshot

WallDuration	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 steady_timer_options.h.

Constructor & Destructor Documentation

◆ SteadyTimerOptions() [1/2]

ros::SteadyTimerOptions::SteadyTimerOptions ( )

inline

Definition at line 42 of file steady_timer_options.h.

◆ SteadyTimerOptions() [2/2]

ros::SteadyTimerOptions::SteadyTimerOptions	(	WallDuration	_period,
		const SteadyTimerCallback &	_callback,
		CallbackQueueInterface *	_queue,
		bool	oneshot = `false`,
		bool	autostart = `true`
	)

inline

Definition at line 54 of file steady_timer_options.h.

Member Data Documentation

◆ autostart

bool ros::SteadyTimerOptions::autostart

Definition at line 79 of file steady_timer_options.h.

◆ callback

SteadyTimerCallback ros::SteadyTimerOptions::callback

The callback to call.

Definition at line 64 of file steady_timer_options.h.

◆ callback_queue

CallbackQueueInterface* ros::SteadyTimerOptions::callback_queue

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

Definition at line 66 of file steady_timer_options.h.

◆ oneshot

bool ros::SteadyTimerOptions::oneshot

Definition at line 78 of file steady_timer_options.h.

◆ period

WallDuration ros::SteadyTimerOptions::period

The period to call the callback at.

Definition at line 63 of file steady_timer_options.h.

◆ tracked_object

VoidConstPtr ros::SteadyTimerOptions::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 76 of file steady_timer_options.h.

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

steady_timer_options.h

Public Member Functions

Public Attributes