rclcpp_lifecycle
master
C++ ROS Lifecycle Library API
|
The Transition class abstract the Lifecycle's states. More...
#include <transition.hpp>
Public Member Functions | |
Transition ()=delete | |
Transition (uint8_t id, const std::string &label="", rcutils_allocator_t allocator=rcutils_get_default_allocator()) | |
Transition constructor. More... | |
Transition (uint8_t id, const std::string &label, State &&start, State &&goal, rcutils_allocator_t allocator=rcutils_get_default_allocator()) | |
Transition constructor. More... | |
Transition (const rcl_lifecycle_transition_t *rcl_lifecycle_transition_handle, rcutils_allocator_t allocator=rcutils_get_default_allocator()) | |
Transition constructor. More... | |
Transition (const Transition &rhs) | |
virtual | ~Transition () |
Transition & | operator= (const Transition &rhs) |
uint8_t | id () const |
Return the id. More... | |
std::string | label () const |
Return the label. More... | |
State | start_state () const |
Return the start state of the transition. More... | |
State | goal_state () const |
Return the goal state of the transition. More... | |
Protected Member Functions | |
void | reset () |
Protected Attributes | |
rcutils_allocator_t | allocator_ |
bool | owns_rcl_transition_handle_ |
rcl_lifecycle_transition_t * | transition_handle_ |
The Transition class abstract the Lifecycle's states.
There are 7 transitions exposed to a supervisory process, they are: create, configure, cleanup, activate, deactivate, shutdown and destroy.
|
delete |
|
explicit |
Transition constructor.
[in] | id | of the transition |
[in] | label | of the transition |
[in] | allocator | a valid allocator used to initialized the state. |
rclcpp_lifecycle::Transition::Transition | ( | uint8_t | id, |
const std::string & | label, | ||
State && | start, | ||
State && | goal, | ||
rcutils_allocator_t | allocator = rcutils_get_default_allocator() |
||
) |
Transition constructor.
[in] | id | of the transition |
[in] | label | of the transition |
[in] | start | state of the transition |
[in] | goal | state of the transition |
[in] | allocator | a valid allocator used to initialized the state. |
|
explicit |
Transition constructor.
[in] | rcl_lifecycle_transition_handle | structure with the transition details |
[in] | allocator | a valid allocator used to initialized the state. |
rclcpp_lifecycle::Transition::Transition | ( | const Transition & | rhs | ) |
|
virtual |
Transition& rclcpp_lifecycle::Transition::operator= | ( | const Transition & | rhs | ) |
uint8_t rclcpp_lifecycle::Transition::id | ( | ) | const |
Return the id.
std::string rclcpp_lifecycle::Transition::label | ( | ) | const |
Return the label.
State rclcpp_lifecycle::Transition::start_state | ( | ) | const |
Return the start state of the transition.
State rclcpp_lifecycle::Transition::goal_state | ( | ) | const |
Return the goal state of the transition.
|
protected |
|
protected |
|
protected |
|
protected |