rclcpp::WallTimer< FunctorT, > Class Template Reference

#include <timer.hpp>

Inheritance diagram for rclcpp::WallTimer< FunctorT, >:

Collaboration diagram for rclcpp::WallTimer< FunctorT, >:

Public Member Functions
	WallTimer (std::chrono::nanoseconds period, FunctorT &&callback, rclcpp::Context::SharedPtr context)
	Wall timer constructor. More...
Public Member Functions inherited from rclcpp::GenericTimer< FunctorT >
	GenericTimer (Clock::SharedPtr clock, std::chrono::nanoseconds period, FunctorT &&callback, rclcpp::Context::SharedPtr context)
	Default constructor. More...
virtual	~GenericTimer ()
	Default destructor. More...
void	execute_callback () override
void	execute_callback_delegate ()
void	execute_callback_delegate ()
bool	is_steady () override
	Is the clock steady (i.e. is the time between ticks constant?) More...
Public Member Functions inherited from rclcpp::TimerBase
	TimerBase (Clock::SharedPtr clock, std::chrono::nanoseconds period, rclcpp::Context::SharedPtr context)
	TimerBase constructor. More...
virtual	~TimerBase ()
	TimerBase destructor. More...
void	cancel ()
	Cancel the timer. More...
bool	is_canceled ()
	Return the timer cancellation state. More...
void	reset ()
	Reset the timer. More...
std::shared_ptr< const rcl_timer_t >	get_timer_handle ()
std::chrono::nanoseconds	time_until_trigger ()
	Check how long the timer has until its next scheduled callback. More...
bool	is_ready ()
	Check if the timer is ready to trigger the callback. More...
bool	exchange_in_use_by_wait_set_state (bool in_use_state)
	Exchange the "in use by wait set" state for this timer. More...

Additional Inherited Members
Protected Attributes inherited from rclcpp::GenericTimer< FunctorT >
FunctorT	callback_
Protected Attributes inherited from rclcpp::TimerBase
Clock::SharedPtr	clock_
std::shared_ptr< rcl_timer_t >	timer_handle_
std::atomic< bool >	in_use_by_wait_set_ {false}

Constructor & Destructor Documentation

WallTimer()

template<typename FunctorT , typename std::enable_if< rclcpp::function_traits::same_arguments< FunctorT, VoidCallbackType >::value||rclcpp::function_traits::same_arguments< FunctorT, TimerCallbackType >::value >::type * = nullptr>

rclcpp::WallTimer< FunctorT, >::WallTimer ( std::chrono::nanoseconds  period, FunctorT &&  callback, rclcpp::Context::SharedPtr  context  )

inline

Wall timer constructor.

Parameters

period	The interval at which the timer fires
callback	The callback function to execute every interval
context	node context

---

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

• include/rclcpp/timer.hpp