rclcpp  master
C++ ROS Client Library API
Public Member Functions | List of all members
rclcpp::QOSEventHandler< EventCallbackT, ParentHandleT > Class Template Reference

#include <qos_event.hpp>

Inheritance diagram for rclcpp::QOSEventHandler< EventCallbackT, ParentHandleT >:
Inheritance graph
[legend]
Collaboration diagram for rclcpp::QOSEventHandler< EventCallbackT, ParentHandleT >:
Collaboration graph
[legend]

Public Member Functions

template<typename InitFuncT , typename EventTypeEnum >
 QOSEventHandler (const EventCallbackT &callback, InitFuncT init_func, ParentHandleT parent_handle, EventTypeEnum event_type)
 
std::shared_ptr< void > take_data () override
 Take data so that the callback cannot be scheduled again. More...
 
void execute (std::shared_ptr< void > &data) override
 Execute any entities of the Waitable that are ready. More...
 
- Public Member Functions inherited from rclcpp::QOSEventHandlerBase
virtual ~QOSEventHandlerBase ()
 
size_t get_number_of_ready_events () override
 Get the number of ready events. More...
 
bool add_to_wait_set (rcl_wait_set_t *wait_set) override
 Add the Waitable to a wait set. More...
 
bool is_ready (rcl_wait_set_t *wait_set) override
 Check if the Waitable is ready. More...
 
- Public Member Functions inherited from rclcpp::Waitable
virtual ~Waitable ()=default
 
virtual size_t get_number_of_ready_subscriptions ()
 Get the number of ready subscriptions. More...
 
virtual size_t get_number_of_ready_timers ()
 Get the number of ready timers. More...
 
virtual size_t get_number_of_ready_clients ()
 Get the number of ready clients. More...
 
virtual size_t get_number_of_ready_services ()
 Get the number of ready services. More...
 
virtual size_t get_number_of_ready_guard_conditions ()
 Get the number of ready guard_conditions. 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::QOSEventHandlerBase
rcl_event_t event_handle_
 
size_t wait_set_event_index_
 

Constructor & Destructor Documentation

◆ QOSEventHandler()

template<typename EventCallbackT , typename ParentHandleT >
template<typename InitFuncT , typename EventTypeEnum >
rclcpp::QOSEventHandler< EventCallbackT, ParentHandleT >::QOSEventHandler ( const EventCallbackT &  callback,
InitFuncT  init_func,
ParentHandleT  parent_handle,
EventTypeEnum  event_type 
)
inline

Member Function Documentation

◆ take_data()

template<typename EventCallbackT , typename ParentHandleT >
std::shared_ptr<void> rclcpp::QOSEventHandler< EventCallbackT, ParentHandleT >::take_data ( )
inlineoverridevirtual

Take data so that the callback cannot be scheduled again.

Implements rclcpp::Waitable.

◆ execute()

template<typename EventCallbackT , typename ParentHandleT >
void rclcpp::QOSEventHandler< EventCallbackT, ParentHandleT >::execute ( std::shared_ptr< void > &  data)
inlineoverridevirtual

Execute any entities of the Waitable that are ready.

Implements rclcpp::Waitable.


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