tf2_ros::CreateTimerInterface Class Reference

Abstract interface for creating timers. More...

#include <create_timer_interface.h>

Inheritance diagram for tf2_ros::CreateTimerInterface:

Public Types
using	SharedPtr = std::shared_ptr< CreateTimerInterface >
using	ConstSharedPtr = std::shared_ptr< const CreateTimerInterface >
using	UniquePtr = std::unique_ptr< CreateTimerInterface >

Public Member Functions
virtual TF2_ROS_PUBLIC	~CreateTimerInterface ()=default
virtual TF2_ROS_PUBLIC TimerHandle	createTimer (rclcpp::Clock::SharedPtr clock, const tf2::Duration &period, TimerCallbackType callback)=0
	Create a new timer. More...
virtual TF2_ROS_PUBLIC void	cancel (const TimerHandle &timer_handle)=0
	Cancel a timer. More...
virtual TF2_ROS_PUBLIC void	reset (const TimerHandle &timer_handle)=0
	Reset the timer. More...
virtual TF2_ROS_PUBLIC void	remove (const TimerHandle &timer_handle)=0
	Remove a timer. More...

Detailed Description

Abstract interface for creating timers.

Member Typedef Documentation

SharedPtr

using tf2_ros::CreateTimerInterface::SharedPtr = std::shared_ptr<CreateTimerInterface>

ConstSharedPtr

using tf2_ros::CreateTimerInterface::ConstSharedPtr = std::shared_ptr<const CreateTimerInterface>

UniquePtr

using tf2_ros::CreateTimerInterface::UniquePtr = std::unique_ptr<CreateTimerInterface>

Constructor & Destructor Documentation

~CreateTimerInterface()

virtual TF2_ROS_PUBLIC tf2_ros::CreateTimerInterface::~CreateTimerInterface ( )

virtualdefault

Member Function Documentation

createTimer()

virtual TF2_ROS_PUBLIC TimerHandle tf2_ros::CreateTimerInterface::createTimer ( rclcpp::Clock::SharedPtr  clock, const tf2::Duration &  period, TimerCallbackType  callback  )

pure virtual

Create a new timer.

After creation, the timer will periodically execute the user-provided callback.

Parameters

clock	The clock providing the current time
period	The interval at which the timer fires
callback	The callback function to execute every interval

Implemented in tf2_ros::CreateTimerROS.

cancel()

virtual TF2_ROS_PUBLIC void tf2_ros::CreateTimerInterface::cancel ( const TimerHandle &  timer_handle )

pure virtual

Cancel a timer.

The timer will stop executing user callbacks.

Parameters

timer_handle

Handle to the timer to cancel \raises tf2_ros::InvalidTimerHandleException if the timer does not exist

Implemented in tf2_ros::CreateTimerROS.

reset()

virtual TF2_ROS_PUBLIC void tf2_ros::CreateTimerInterface::reset ( const TimerHandle &  timer_handle )

pure virtual

Reset the timer.

The timer will reset and continue to execute user callbacks periodically.

Parameters

timer_handle

Handle to the timer to reset \raises tf2_ros::InvalidTimerHandleException if the timer does not exist

Implemented in tf2_ros::CreateTimerROS.

remove()

virtual TF2_ROS_PUBLIC void tf2_ros::CreateTimerInterface::remove ( const TimerHandle &  timer_handle )

pure virtual

Remove a timer.

The timer will be canceled and removed from internal storage.

Parameters

timer_handle

Handle to the timer to reset \raises tf2_ros::InvalidTimerHandleException if the timer does not exist

Implemented in tf2_ros::CreateTimerROS.

---

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

• /tmp/tmp.G0mQUHO3yi/src/ros2/geometry2/tf2_ros/include/tf2_ros/create_timer_interface.h