This Behavior removes a URDF object from the planning scene. More...

#include <remove_urdf_from_scene.hpp>

Inheritance diagram for moveit_pro::behaviors::RemoveURDFFromScene:

[legend]

Collaboration diagram for moveit_pro::behaviors::RemoveURDFFromScene:

[legend]

Public Member Functions
	RemoveURDFFromScene (const std::string &name, const BT::NodeConfiguration &config, const std::shared_ptr< BehaviorContext > &shared_resources)
	Constructs a RemoveURDFFromScene behavior node.

	RemoveURDFFromScene (const std::string &name, const BT::NodeConfiguration &config, const std::shared_ptr< BehaviorContext > &shared_resources, std::unique_ptr< ClientInterfaceBase< DetachOrRemoveURDFSrv > > client_interface)
	Constructs a RemoveURDFFromScene behavior node with a custom service client.

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

	DetachOrRemoveURDF (const std::string &name, const BT::NodeConfiguration &config, const std::shared_ptr< BehaviorContext > &shared_resources, std::unique_ptr< ClientInterfaceBase< DetachOrRemoveURDFSrv > > client_interface)

Public Member Functions inherited from moveit_pro::behaviors::ServiceClientBehaviorBase< moveit_studio_agent_msgs::srv::DetachOrRemoveURDF >
	ServiceClientBehaviorBase (const std::string &name, const BT::NodeConfiguration &config, const std::shared_ptr< BehaviorContext > &shared_resources)
	Constructs ServiceClientBehaviorBase using the RclcppClientInterface.

	ServiceClientBehaviorBase (const std::string &name, const BT::NodeConfiguration &config, const std::shared_ptr< BehaviorContext > &shared_resources, std::unique_ptr< ClientInterfaceBase< moveit_studio_agent_msgs::srv::DetachOrRemoveURDF > > client_interface)
	Constructs ServiceClientBehaviorBase using a user-provided implementation of ClientInterfaceBase.

	~ServiceClientBehaviorBase () override=default

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

	~AsyncBehaviorBase () override=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_pro::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::KeyValueVector	metadata ()
	Provides metadata for UI display and behavior categorization.

Static Public Member Functions inherited from moveit_pro::behaviors::DetachOrRemoveURDF
static BT::PortsList	providedPorts ()

Additional Inherited Members
Public Types inherited from moveit_pro::behaviors::DetachOrRemoveURDF
using	DetachOrRemoveURDFSrv = moveit_studio_agent_msgs::srv::DetachOrRemoveURDF

Static Public Attributes inherited from moveit_pro::behaviors::DetachOrRemoveURDF
static constexpr auto	kDefaultUrdfNamePort = "urdf_name"

static constexpr auto	kDetachURDFBehaviorName = "DetachURDF"

static constexpr auto	kRemoveURDFFromSceneBehaviorName = "RemoveURDFFromScene"

static constexpr auto	kDetachURDFServiceName = "detach_urdf"

static constexpr auto	kRemoveURDFFromSceneServiceName = "remove_urdf_from_scene"

Static Public Attributes inherited from moveit_pro::behaviors::ServiceClientBehaviorBase< moveit_studio_agent_msgs::srv::DetachOrRemoveURDF >
static constexpr std::chrono::seconds	kTimeoutWaitForServiceServer

Protected Member Functions inherited from moveit_pro::behaviors::DetachOrRemoveURDF
virtual std::string	getUrdfNamePort () const

Protected Member Functions inherited from moveit_pro::behaviors::ServiceClientBehaviorBase< moveit_studio_agent_msgs::srv::DetachOrRemoveURDF >
virtual tl::expected< std::chrono::duration< double >, std::string >	getWaitForServerAvailableTimeout ()
	Optional user-provided function to set the timeout used when waiting for the service server to be available.

virtual tl::expected< bool, std::string >	processResponse (const typename ServiceT::Response &)
	Optional user-provided function to process the service response after the service has finished.

tl::expected< void, std::string >	doHalt () override
	Handles halting logic which is specific to the service client behavior implementation.

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

Protected Attributes inherited from moveit_pro::behaviors::DetachOrRemoveURDF
std::string	service_name_

Protected Attributes inherited from moveit_pro::behaviors::SharedResourcesNode< BT::StatefulActionNode >
std::shared_ptr< BehaviorContext >	shared_resources_

Detailed Description

This Behavior removes a URDF object from the planning scene.

The URDF object with the given urdf_name will be removed from the planning scene. Once removed, the object will no longer be able to be attached to the robot until it is added to the planning scene again.

Data Port Name	Port Type	Object Type
urdf_name	input	std::string

Constructor & Destructor Documentation

◆ RemoveURDFFromScene() [1/2]

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

Constructs a RemoveURDFFromScene behavior node.

Parameters

name	The unique identifier for this node instance in the behavior tree.
config	Configuration object containing input/output port bindings and blackboard access.
shared_resources	Provides access to MoveIt planning scene, robot model, and ROS node interfaces.

◆ RemoveURDFFromScene() [2/2]

moveit_pro::behaviors::RemoveURDFFromScene::RemoveURDFFromScene	(	const std::string &	name,
		const BT::NodeConfiguration &	config,
		const std::shared_ptr< BehaviorContext > &	shared_resources,
		std::unique_ptr< ClientInterfaceBase< DetachOrRemoveURDFSrv > >	client_interface
	)

Constructs a RemoveURDFFromScene behavior node with a custom service client.

Parameters

name	The unique identifier for this node instance in the behavior tree.
config	Configuration object containing input/output port bindings and blackboard access.
shared_resources	Provides access to MoveIt planning scene, robot model, and ROS node interfaces.
client_interface	Custom or mock service client implementation, typically used for unit testing.

Member Function Documentation

◆ metadata()

BT::KeyValueVector moveit_pro::behaviors::RemoveURDFFromScene::metadata ( )

static

Provides metadata for UI display and behavior categorization.

Returns: Key-value pairs defining the behavior's subcategory and description for the palette.

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

Public Member Functions