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

#include <event.hpp>

Public Member Functions

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

Constructor & Destructor Documentation

◆ Event()

rclcpp::Event::Event ( )

Default construct.

Set the default value to false

Member Function Documentation

◆ set()

bool rclcpp::Event::set ( )

Set the Event state value to true.

Returns
The state value before the call.

◆ check()

bool rclcpp::Event::check ( )

Get the state value of the Event.

Returns
the Event state value

◆ 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

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