Lists controllers from the controller manager with two independent filters. More...

#include <list_controllers.hpp>

Inheritance diagram for moveit_pro::behaviors::ListControllers:

[legend]

Collaboration diagram for moveit_pro::behaviors::ListControllers:

[legend]

Public Member Functions
	ListControllers (const std::string &name, const BT::NodeConfiguration &config, const std::shared_ptr< BehaviorContext > &shared_resources)
	Constructor for ListControllers behavior.

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

Public Member Functions inherited from moveit_pro::behaviors::ServiceClientBehaviorBase< controller_manager_msgs::srv::ListControllers >
	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< controller_manager_msgs::srv::ListControllers > > 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::PortsList	providedPorts ()
	Defines the input/output ports for this behavior.

static BT::KeyValueVector	metadata ()
	Provides metadata about the behavior for the behavior tree editor.

Additional Inherited Members
Static Public Attributes inherited from moveit_pro::behaviors::ServiceClientBehaviorBase< controller_manager_msgs::srv::ListControllers >
static constexpr std::chrono::seconds	kTimeoutWaitForServiceServer

Protected Member Functions inherited from moveit_pro::behaviors::ServiceClientBehaviorBase< controller_manager_msgs::srv::ListControllers >
virtual tl::expected< std::chrono::duration< double >, std::string >	getResponseTimeout ()
	Optional user-provided function to set the timeout used when waiting for the service response.

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::SharedResourcesNode< BT::StatefulActionNode >
std::shared_ptr< BehaviorContext >	shared_resources_

Detailed Description

Lists controllers from the controller manager with two independent filters.

This behavior queries the controller manager and returns a semicolon-separated list of controller names. Two filters can be combined:

state (by controller state):

'all': all controllers regardless of state
'active' (default): only active controllers
'inactive': only inactive controllers

type (by interface type):

'all' (default): all controllers matching the state filter
'command': only controllers that claim command interfaces (e.g. joint_trajectory_controller)
'state': only controllers with no command interfaces (e.g. joint_state_broadcaster)

This is useful for composing with SwitchController to save/restore controller states.

Data Port Name	Port Type	Object Type
service_name	Input	std::string
state	Input	std::string
type	Input	std::string
controller_list	Output	std::vector<std::string>

Constructor & Destructor Documentation

◆ ListControllers() [1/2]

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

Constructor for ListControllers behavior.

Parameters

name	Name of the behavior node.
config	BehaviorTree node configuration.
shared_resources	Shared resources for the behavior (ROS node, planning scene, etc.).

◆ ListControllers() [2/2]

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

Member Function Documentation

◆ metadata()

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

static

Provides metadata about the behavior for the behavior tree editor.

Returns: Key-value pairs describing subcategory and description.

◆ providedPorts()

BT::PortsList moveit_pro::behaviors::ListControllers::providedPorts ( )

static

Defines the input/output ports for this behavior.

Returns: List of ports with their types and descriptions.

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

Public Member Functions

Static Public Member Functions