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

#include <wall_timer_options.h>

Public Member Functions
	WallTimerOptions ()

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

Public Attributes
bool	autostart

WallTimerCallback	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 41 of file wall_timer_options.h.

Constructor & Destructor Documentation

◆ WallTimerOptions() [1/2]

roswrap::WallTimerOptions::WallTimerOptions ( )

inline

Definition at line 43 of file wall_timer_options.h.

◆ WallTimerOptions() [2/2]

roswrap::WallTimerOptions::WallTimerOptions	(	WallDuration	_period,
		const WallTimerCallback &	_callback,
		CallbackQueueInterface *	_queue,
		bool	oneshot = `false`,
		bool	autostart = `true`
	)

inline

Definition at line 55 of file wall_timer_options.h.

Member Data Documentation

◆ autostart

bool roswrap::WallTimerOptions::autostart

Definition at line 80 of file wall_timer_options.h.

◆ callback

WallTimerCallback roswrap::WallTimerOptions::callback

The callback to call.

Definition at line 65 of file wall_timer_options.h.

◆ callback_queue

CallbackQueueInterface* roswrap::WallTimerOptions::callback_queue

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

Definition at line 67 of file wall_timer_options.h.

◆ oneshot

bool roswrap::WallTimerOptions::oneshot

Definition at line 79 of file wall_timer_options.h.

◆ period

WallDuration roswrap::WallTimerOptions::period

The period to call the callback at.

Definition at line 64 of file wall_timer_options.h.

◆ tracked_object

VoidConstPtr roswrap::WallTimerOptions::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 77 of file wall_timer_options.h.

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

wall_timer_options.h

Public Member Functions

Public Attributes