rclcpp_action  master
C++ ROS Action Client Library
Public Member Functions | Protected Member Functions | List of all members
rclcpp_action::ServerGoalHandleBase Class Reference

#include <server_goal_handle.hpp>

Inheritance diagram for rclcpp_action::ServerGoalHandleBase:
Inheritance graph
[legend]

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
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ ~ServerGoalHandleBase()

virtual RCLCPP_ACTION_PUBLIC rclcpp_action::ServerGoalHandleBase::~ServerGoalHandleBase ( )
virtual

◆ ServerGoalHandleBase()

RCLCPP_ACTION_PUBLIC rclcpp_action::ServerGoalHandleBase::ServerGoalHandleBase ( std::shared_ptr< rcl_action_goal_handle_t rcl_handle)
inlineprotected

Member Function Documentation

◆ is_canceling()

RCLCPP_ACTION_PUBLIC bool rclcpp_action::ServerGoalHandleBase::is_canceling ( ) const

Indicate if client has requested this goal be cancelled.

Returns
true if a cancelation request has been accepted for this goal.

◆ is_active()

RCLCPP_ACTION_PUBLIC bool rclcpp_action::ServerGoalHandleBase::is_active ( ) const

Indicate if goal is pending or executing.

Returns
false if goal has reached a terminal state.

◆ is_executing()

RCLCPP_ACTION_PUBLIC bool rclcpp_action::ServerGoalHandleBase::is_executing ( ) const

Indicate if goal is executing.

Returns
true only if the goal is in an executing state.

◆ _abort()

RCLCPP_ACTION_PUBLIC void rclcpp_action::ServerGoalHandleBase::_abort ( )
protected

◆ _succeed()

RCLCPP_ACTION_PUBLIC void rclcpp_action::ServerGoalHandleBase::_succeed ( )
protected

◆ _cancel_goal()

RCLCPP_ACTION_PUBLIC void rclcpp_action::ServerGoalHandleBase::_cancel_goal ( )
protected

◆ _canceled()

RCLCPP_ACTION_PUBLIC void rclcpp_action::ServerGoalHandleBase::_canceled ( )
protected

◆ _execute()

RCLCPP_ACTION_PUBLIC void rclcpp_action::ServerGoalHandleBase::_execute ( )
protected

◆ try_canceling()

RCLCPP_ACTION_PUBLIC bool rclcpp_action::ServerGoalHandleBase::try_canceling ( )
protectednoexcept

Transition the goal to canceled state if it never reached a terminal state.


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