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

Component responsible for execution of commands to move robotic arm (manipulator) based on set trajectory goal. More...

#include <JointsTrajectoryComponent.h>

Inherits AZ::Component, AZ::TickBus::Handler, and JointsTrajectoryRequestBus::Handler.

Public Member Functions

 JointsTrajectoryComponent (const AZStd::string &followTrajectoryActionName)
 
 AZ_COMPONENT (JointsTrajectoryComponent, "{429DE04C-6B6D-4B2D-9D6C-3681F23CBF90}", AZ::Component)
 
AZ::Outcome< void, TrajectoryResult > StartTrajectoryGoal (TrajectoryGoalPtr trajectoryGoal) override
 
AZ::Outcome< void, AZStd::string > CancelTrajectoryGoal () override
 
TrajectoryActionStatus GetGoalStatus () override
 

Static Public Member Functions

static void GetRequiredServices (AZ::ComponentDescriptor::DependencyArrayType &required)
 
static void GetProvidedServices (AZ::ComponentDescriptor::DependencyArrayType &provided)
 
static void GetIncompatibleServices (AZ::ComponentDescriptor::DependencyArrayType &incompatible)
 
static void Reflect (AZ::ReflectContext *context)
 

Detailed Description

Component responsible for execution of commands to move robotic arm (manipulator) based on set trajectory goal.

Member Function Documentation

◆ CancelTrajectoryGoal()

AZ::Outcome<void, AZStd::string> ROS2::JointsTrajectoryComponent::CancelTrajectoryGoal ( )
override
See also
ROS2::JointsTrajectoryRequestBus::CancelTrajectoryGoal

◆ GetGoalStatus()

TrajectoryActionStatus ROS2::JointsTrajectoryComponent::GetGoalStatus ( )
override
See also
ROS2::JointsTrajectoryRequestBus::GetGoalStatus

◆ StartTrajectoryGoal()

AZ::Outcome<void, TrajectoryResult> ROS2::JointsTrajectoryComponent::StartTrajectoryGoal ( TrajectoryGoalPtr  trajectoryGoal)
override
See also
ROS2::JointsTrajectoryRequestBus::StartTrajectoryGoal

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