rclcpp_action
master
C++ ROS Action Client Library
|
#include <server_goal_handle.hpp>
Public Member Functions | |
RCLCPP_ACTION_PUBLIC bool | is_canceling () const |
RCLCPP_ACTION_PUBLIC bool | is_active () const |
RCLCPP_ACTION_PUBLIC bool | is_executing () const |
virtual RCLCPP_ACTION_PUBLIC | ~ServerGoalHandleBase () |
Protected Member Functions | |
RCLCPP_ACTION_PUBLIC | ServerGoalHandleBase (std::shared_ptr< rcl_action_goal_handle_t > rcl_handle) |
RCLCPP_ACTION_PUBLIC void | _abort () |
RCLCPP_ACTION_PUBLIC void | _succeed () |
RCLCPP_ACTION_PUBLIC void | _cancel_goal () |
RCLCPP_ACTION_PUBLIC void | _canceled () |
RCLCPP_ACTION_PUBLIC void | _execute () |
RCLCPP_ACTION_PUBLIC bool | try_canceling () noexcept |
Base class to interact with goals on a server. This class in not be used directly by users writing an action server. Instead users will be given an instance of rclcpp_action::ServerGoalHandle<>
.
Internally, this class is responsible for interfacing with the rcl_action
API.
|
virtual |
|
inlineprotected |
RCLCPP_ACTION_PUBLIC bool rclcpp_action::ServerGoalHandleBase::is_canceling | ( | ) | const |
Indicate if client has requested this goal be cancelled.
RCLCPP_ACTION_PUBLIC bool rclcpp_action::ServerGoalHandleBase::is_active | ( | ) | const |
Indicate if goal is pending or executing.
RCLCPP_ACTION_PUBLIC bool rclcpp_action::ServerGoalHandleBase::is_executing | ( | ) | const |
Indicate if goal is executing.
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protectednoexcept |
Transition the goal to canceled state if it never reached a terminal state.