rclcpp_lifecycle
master
C++ ROS Lifecycle Library API
|
Abstract class for the Lifecycle's states. More...
#include <state.hpp>
Public Member Functions | |
State (rcutils_allocator_t allocator=rcutils_get_default_allocator()) | |
State (uint8_t id, const std::string &label, rcutils_allocator_t allocator=rcutils_get_default_allocator()) | |
State constructor. More... | |
State (const rcl_lifecycle_state_t *rcl_lifecycle_state_handle, rcutils_allocator_t allocator=rcutils_get_default_allocator()) | |
State constructor. More... | |
State (const State &rhs) | |
virtual | ~State () |
State & | operator= (const State &rhs) |
uint8_t | id () const |
Return the id. More... | |
std::string | label () const |
Return the label. More... | |
Protected Member Functions | |
void | reset () |
Protected Attributes | |
rcutils_allocator_t | allocator_ |
bool | owns_rcl_state_handle_ |
rcl_lifecycle_state_t * | state_handle_ |
Abstract class for the Lifecycle's states.
There are 4 primary states: Unconfigured, Inactive, Active and Finalized.
|
explicit |
rclcpp_lifecycle::State::State | ( | uint8_t | id, |
const std::string & | label, | ||
rcutils_allocator_t | allocator = rcutils_get_default_allocator() |
||
) |
State constructor.
[in] | id | of the state |
[in] | label | of the state |
[in] | allocator | a valid allocator used to initialized the state. |
|
explicit |
State constructor.
[in] | rcl_lifecycle_state_handle | structure with the state details |
[in] | allocator | a valid allocator used to initialized the state. |
rclcpp_lifecycle::State::State | ( | const State & | rhs | ) |
|
virtual |
uint8_t rclcpp_lifecycle::State::id | ( | ) | const |
Return the id.
std::string rclcpp_lifecycle::State::label | ( | ) | const |
Return the label.
|
protected |
|
protected |
|
protected |
|
protected |