mrs_lib::RosTimerOptions Struct Reference

Options for creating a ROS-based timer. More...

#include <timer.hpp>

Public Attributes
TimerNodeInterfaces	node_interfaces
	ROS node interfaces used by the timer.
bool	autostart = true
	Whether the timer should start automatically after construction.
bool	oneshot = false
	Whether the timer should execute its callback only once.
std::shared_ptr< rclcpp::CallbackGroup >	callback_group = nullptr
	Callback group in which the timer callback should be executed.

Detailed Description

Options for creating a ROS-based timer.

When configuring timer with these options, it will use rclcpp::Timer internally. (See mrs_lib::Timer documentation for differences in implementations.)

Member Data Documentation

callback_group

std::shared_ptr<rclcpp::CallbackGroup> mrs_lib::RosTimerOptions::callback_group = nullptr

Callback group in which the timer callback should be executed.

If nullptr, the default callback group is used.

oneshot

bool mrs_lib::RosTimerOptions::oneshot = false

Whether the timer should execute its callback only once.

If true, the timer stops after exactly one callback is executed.

---

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

• /home/runner/work/mrs_lib/mrs_lib/include/mrs_lib/timer.hpp