Open 3D Engine ROS2 Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
ROS2::GripperActionServer Class Reference

#include <GripperActionServer.h>

Public Types

using GripperCommand = control_msgs::action::GripperCommand
 
using GoalHandleGripperCommand = rclcpp_action::ServerGoalHandle< control_msgs::action::GripperCommand >
 

Public Member Functions

 GripperActionServer (const AZStd::string &actionName, const AZ::EntityId &entityId)
 
void CancelGoal (std::shared_ptr< GripperCommand::Result > result)
 
void GoalSuccess (std::shared_ptr< GripperCommand::Result > result)
 
void PublishFeedback (std::shared_ptr< GripperCommand::Feedback > feedback)
 
bool IsGoalActiveState () const
 Check if the goal is in an active state.
 
bool IsReadyForExecution () const
 Check if the goal is in a pending state.
 

Detailed Description

GripperActionServer is a class responsible for managing an action server controlling a gripper

See also
ROS 2 action server documentation
GripperCommand documentation

Constructor & Destructor Documentation

◆ GripperActionServer()

ROS2::GripperActionServer::GripperActionServer ( const AZStd::string &  actionName,
const AZ::EntityId &  entityId 
)

Create an action server for GripperAction action and bind Goal callbacks.

Parameters
actionNameName of the action, similar to topic or service name.
entityIdentity which will execute callbacks through GripperRequestBus.

Member Function Documentation

◆ CancelGoal()

void ROS2::GripperActionServer::CancelGoal ( std::shared_ptr< GripperCommand::Result >  result)

Cancel the current goal.

Parameters
resultResult to be passed to through action server to the client.

◆ GoalSuccess()

void ROS2::GripperActionServer::GoalSuccess ( std::shared_ptr< GripperCommand::Result >  result)

Report goal success to the action server.

Parameters
resultResult which contains success code.

◆ PublishFeedback()

void ROS2::GripperActionServer::PublishFeedback ( std::shared_ptr< GripperCommand::Feedback >  feedback)

Publish feedback during an active action.

Parameters
feedbackAn action feedback message informing about the progress.

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