rclcpp::Event Class Reference

Public Member Functions
RCLCPP_PUBLIC	Event ()
	Default construct. More...
RCLCPP_PUBLIC bool	set ()
	Set the Event state value to true. More...
RCLCPP_PUBLIC bool	check ()
	Get the state value of the Event. More...
RCLCPP_PUBLIC bool	check_and_clear ()
	Get the state value of the Event and set to false. More...

Detailed Description

Definition at line 27 of file event.hpp.

Constructor & Destructor Documentation

Event()

rclcpp::Event::Event

(

)

Default construct.

Set the default value to false

Definition at line 20 of file event.cpp.

Member Function Documentation

check()

bool rclcpp::Event::check

(

)

Get the state value of the Event.

Returns

the Event state value

Definition at line 30 of file event.cpp.

check_and_clear()

bool rclcpp::Event::check_and_clear

(

)

Get the state value of the Event and set to false.

Returns

the Event state value

Definition at line 36 of file event.cpp.

set()

bool rclcpp::Event::set

(

)

Set the Event state value to true.

Returns

The state value before the call.

Definition at line 24 of file event.cpp.

---

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

• rclcpp/include/rclcpp/event.hpp
• rclcpp/src/rclcpp/event.cpp