rclcpp_action  master
C++ ROS Action Client Library
Public Member Functions | Public Attributes | List of all members
rclcpp_action::Client< ActionT >::SendGoalOptions Struct Reference

Options for sending a goal. More...

#include <client.hpp>

Collaboration diagram for rclcpp_action::Client< ActionT >::SendGoalOptions:
Collaboration graph
[legend]

Public Member Functions

 SendGoalOptions ()
 

Public Attributes

GoalResponseCallback goal_response_callback
 Function called when the goal is accepted or rejected. More...
 
FeedbackCallback feedback_callback
 Function called whenever feedback is received for the goal. More...
 
ResultCallback result_callback
 Function called when the result for the goal is received. More...
 

Detailed Description

template<typename ActionT>
struct rclcpp_action::Client< ActionT >::SendGoalOptions

Options for sending a goal.

This struct is used to pass parameters to the function async_send_goal.

Constructor & Destructor Documentation

◆ SendGoalOptions()

template<typename ActionT >
rclcpp_action::Client< ActionT >::SendGoalOptions::SendGoalOptions ( )
inline

Member Data Documentation

◆ goal_response_callback

template<typename ActionT >
GoalResponseCallback rclcpp_action::Client< ActionT >::SendGoalOptions::goal_response_callback

Function called when the goal is accepted or rejected.

Takes a single argument that is a future to a goal handle shared pointer. If the goal is accepted, then the pointer points to a valid goal handle. If the goal is rejected, then pointer has the value nullptr. If an error occurs while waiting for the goal response an exception will be thrown when calling future::get(). Possible exceptions include rclcpp::RCLError and rclcpp::RCLBadAlloc.

◆ feedback_callback

template<typename ActionT >
FeedbackCallback rclcpp_action::Client< ActionT >::SendGoalOptions::feedback_callback

Function called whenever feedback is received for the goal.

◆ result_callback

template<typename ActionT >
ResultCallback rclcpp_action::Client< ActionT >::SendGoalOptions::result_callback

Function called when the result for the goal is received.


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