rclcpp
master
C++ ROS Client Library API
|
Interface for introspecting a wait set after waiting on it. More...
#include <wait_result.hpp>
Public Member Functions | |
WaitResultKind | kind () const |
Return the kind of the WaitResult. More... | |
const WaitSetT & | get_wait_set () const |
Return the rcl wait set. More... | |
WaitSetT & | get_wait_set () |
Return the rcl wait set. More... | |
WaitResult (WaitResult &&other) noexcept | |
~WaitResult () | |
Static Public Member Functions | |
static WaitResult | from_ready_wait_result_kind (WaitSetT &wait_set) |
Create WaitResult from a "ready" result. More... | |
static WaitResult | from_timeout_wait_result_kind () |
Create WaitResult from a "timeout" result. More... | |
static WaitResult | from_empty_wait_result_kind () |
Create WaitResult from a "empty" result. More... | |
Interface for introspecting a wait set after waiting on it.
This class:
This class is only valid as long as the wait set which created it is valid, and it must be deleted before the wait set is deleted, as it contains a back reference to the wait set.
An instance of this, which is returned from rclcpp::WaitSetTemplate::wait(), will cause the wait set to keep ownership of the entities because it only holds a reference to the sequences of them, rather than taking a copy. Also, in the thread-safe case, an instance of this will cause the wait set, to block calls which modify the sequences of the entities, e.g. add/remove guard condition or subscription methods.
WaitSetT | The wait set type which created this class. |
|
inlinenoexcept |
|
inline |
|
inlinestatic |
Create WaitResult from a "ready" result.
[in] | wait_set | A reference to the wait set, which this class will keep for the duration of its lifetime. |
|
inlinestatic |
Create WaitResult from a "timeout" result.
|
inlinestatic |
Create WaitResult from a "empty" result.
|
inline |
Return the kind of the WaitResult.
|
inline |
Return the rcl wait set.
std::runtime_error | if the class cannot access wait set when the result was not ready |
|
inline |
Return the rcl wait set.
std::runtime_error | if the class cannot access wait set when the result was not ready |