Accepts a JointTrajectory message via an input data port, and executes it by sending a goal to either a standard FollowJointTrajectory action server (JTC) or a Joint Trajectory Admittance Controller (JTAC) action server, depending on the value of the execution_pipeline input port. More...

#include <execute_trajectory.hpp>

Inheritance diagram for moveit_studio::behaviors::ExecuteTrajectory:

[legend]

Collaboration diagram for moveit_studio::behaviors::ExecuteTrajectory:

[legend]

Public Member Functions
	ExecuteTrajectory (const std::string &name, const BT::NodeConfiguration &config, const std::shared_ptr< BehaviorContext > &shared_resources)

std::shared_future< tl::expected< bool, std::string > > &	getFuture () override
	Gets the shared future which is used to monitor the progress of the async process.

Public Member Functions inherited from moveit_studio::behaviors::AsyncBehaviorBase
	AsyncBehaviorBase (const std::string &name, const BT::NodeConfiguration &config, const std::shared_ptr< BehaviorContext > &shared_resources)

virtual	~AsyncBehaviorBase ()=default

BT::NodeStatus	onStart () override
	Required implementation of BT::StatefulActionNode::onStart().

BT::NodeStatus	onRunning () override
	Required implementation of BT::StatefulActionNode::onRunning().

void	onHalted () override
	Required implementation of BT::StatefulActionNode::onHalted().

void	resetStatus ()
	Resets the internal status of this node.

Public Member Functions inherited from moveit_studio::behaviors::SharedResourcesNode< BT::StatefulActionNode >
	SharedResourcesNode (const std::string &name, const BT::NodeConfiguration &config, const std::shared_ptr< BehaviorContext > &shared_resources)
	Constructor for SharedResourcesNode. Called by BT::BehaviorTreeFactory when creating a new behavior tree containing this node.

Static Public Member Functions
static BT::PortsList	providedPorts ()

static BT::KeyValueVector	metadata ()

Protected Member Functions
tl::expected< bool, std::string >	doWork () override
	User-implemented function which handles executing the potentially-long-running process.

tl::expected< void, std::string >	doHalt () override
	Optionally implement additional work needed to cleanly interrupt the async process.

Protected Member Functions inherited from moveit_studio::behaviors::AsyncBehaviorBase
void	notifyCanHalt ()
	Called when runAsync() finishes to notify onHalted() that the async process has finished.

Additional Inherited Members
Protected Attributes inherited from moveit_studio::behaviors::SharedResourcesNode< BT::StatefulActionNode >
std::shared_ptr< BehaviorContext >	shared_resources_

Detailed Description

Accepts a JointTrajectory message via an input data port, and executes it by sending a goal to either a standard FollowJointTrajectory action server (JTC) or a Joint Trajectory Admittance Controller (JTAC) action server, depending on the value of the execution_pipeline input port.

This Behavior consolidates ExecuteFollowJointTrajectory and ExecuteTrajectoryWithAdmittance into a single Behavior.

Data Port Name	Port Type	Object Type
execution_pipeline	Input	std::string
controller_action_name	Input	std::string
joint_trajectory_msg	Input	trajectory_msgs::msg::JointTrajectory
goal_position_tolerance	Input	double
path_position_tolerance	Input	double
absolute_force_torque_threshold	Input	std::vector<double>
admittance_parameters_msg	Input	moveit_pro_controllers_msgs::msg::AdmittanceParameters
goal_duration_tolerance	Input	double

Constructor & Destructor Documentation

◆ ExecuteTrajectory()

moveit_studio::behaviors::ExecuteTrajectory::ExecuteTrajectory	(	const std::string &	name,
		const BT::NodeConfiguration &	config,
		const std::shared_ptr< BehaviorContext > &	shared_resources
	)

Member Function Documentation

◆ doHalt()

tl::expected< void, std::string > moveit_studio::behaviors::ExecuteTrajectory::doHalt ( )

overrideprotectedvirtual

Optionally implement additional work needed to cleanly interrupt the async process.

The default implementation of this function is a no-op which will not interrupt the async process. This will mean that onHalted will wait until the process finishes before returning.

Returns: Return an empty tl::expected<void, std::string> if the additional work to halt was successful. Return an error message if something failed while doing additional work to halt.

Reimplemented from moveit_studio::behaviors::AsyncBehaviorBase.

◆ doWork()

tl::expected< bool, std::string > moveit_studio::behaviors::ExecuteTrajectory::doWork ( )

overrideprotectedvirtual

User-implemented function which handles executing the potentially-long-running process.

This function is called within an async process in a separate thread.

Returns: A tl::expected which contains a bool indicating task success if the process completed successfully or was canceled, or an error message if the process failed unexpectedly.

Implements moveit_studio::behaviors::AsyncBehaviorBase.

◆ getFuture()

std::shared_future< tl::expected< bool, std::string > > & moveit_studio::behaviors::ExecuteTrajectory::getFuture ( )

overridevirtual

Gets the shared future which is used to monitor the progress of the async process.

Classes derived from AsyncBehaviorBase must implement getFuture() so that it returns a shared_future class member.

This exists to prevent destruction of the derived class while the async process is still in-progress. If the derived class is destroyed, the definitions of the functions used within doWork() will be destroyed too, which will result in the virtual functions in the base class being called instead and cause a fault.

This function will force derived classes to add an instance of this type and return a reference to it. The base class can then use this virtual function to access the shared future in functions like onStart.

By adding this virtual function we're properly demonstrating how this future depends on things from the derived class and the natural flow of object lifetimes will do the hard work for us. The std::shared_future destructor will get the value of the future before the derived class is destructed assuming it's the last reference to the shared state. Doing it this way means neither the base nor derived class should need to implement a destructor which is a nice property to have.

Returns: Returns the shared_future, which should be owned by the child class.

Implements moveit_studio::behaviors::AsyncBehaviorBase.

◆ metadata()

BT::KeyValueVector moveit_studio::behaviors::ExecuteTrajectory::metadata ( )

static

◆ providedPorts()

BT::PortsList moveit_studio::behaviors::ExecuteTrajectory::providedPorts ( )

static

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members