rclcpp  master
C++ ROS Client Library API
Public Member Functions | Protected Attributes | List of all members
rclcpp::QOSEventHandlerBase Class Reference

#include <qos_event.hpp>

Inheritance diagram for rclcpp::QOSEventHandlerBase:
Inheritance graph
[legend]
Collaboration diagram for rclcpp::QOSEventHandlerBase:
Collaboration graph
[legend]

Public Member Functions

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...
 
virtual std::shared_ptr< void > take_data ()=0
 Take the data so that it can be consumed with execute. More...
 
virtual void execute (std::shared_ptr< void > &data)=0
 Execute data that is passed in. 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...
 

Protected Attributes

rcl_event_t event_handle_
 
size_t wait_set_event_index_
 

Constructor & Destructor Documentation

◆ ~QOSEventHandlerBase()

virtual rclcpp::QOSEventHandlerBase::~QOSEventHandlerBase ( )
virtual

Member Function Documentation

◆ get_number_of_ready_events()

size_t rclcpp::QOSEventHandlerBase::get_number_of_ready_events ( )
overridevirtual

Get the number of ready events.

Reimplemented from rclcpp::Waitable.

◆ add_to_wait_set()

bool rclcpp::QOSEventHandlerBase::add_to_wait_set ( rcl_wait_set_t wait_set)
overridevirtual

Add the Waitable to a wait set.

Implements rclcpp::Waitable.

◆ is_ready()

bool rclcpp::QOSEventHandlerBase::is_ready ( rcl_wait_set_t wait_set)
overridevirtual

Check if the Waitable is ready.

Implements rclcpp::Waitable.

Member Data Documentation

◆ event_handle_

rcl_event_t rclcpp::QOSEventHandlerBase::event_handle_
protected

◆ wait_set_event_index_

size_t rclcpp::QOSEventHandlerBase::wait_set_event_index_
protected

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