ros2_control - kilted
Loading...
Searching...
No Matches
Public Member Functions | List of all members
effort_controllers::JointGroupEffortController Class Reference

Forward command controller for a set of effort controlled joints (linear or angular). More...

#include <joint_group_effort_controller.hpp>

Inheritance diagram for effort_controllers::JointGroupEffortController:
Inheritance graph
[legend]
Collaboration diagram for effort_controllers::JointGroupEffortController:
Collaboration graph
[legend]

Public Member Functions

controller_interface::CallbackReturn on_init () override
 Extending interface with initialization method which is individual for each controller.
 
controller_interface::CallbackReturn on_deactivate (const rclcpp_lifecycle::State &previous_state) override
 
- Public Member Functions inherited from forward_command_controller::ForwardControllersBase
controller_interface::InterfaceConfiguration command_interface_configuration () const override
 Get configuration for controller's required command interfaces.
 
controller_interface::InterfaceConfiguration state_interface_configuration () const override
 Get configuration for controller's required state interfaces.
 
controller_interface::CallbackReturn on_configure (const rclcpp_lifecycle::State &previous_state) override
 
controller_interface::CallbackReturn on_activate (const rclcpp_lifecycle::State &previous_state) override
 
controller_interface::CallbackReturn on_deactivate (const rclcpp_lifecycle::State &previous_state) override
 
controller_interface::return_type update (const rclcpp::Time &time, const rclcpp::Duration &period) override
 Control step update. Command interfaces are updated based on on reference inputs and current states. The method called in the (real-time) control loop.
 
- Public Member Functions inherited from controller_interface::ControllerInterface
bool is_chainable () const final
 Controller is not chainable.
 
std::vector< hardware_interface::StateInterface::ConstSharedPtr > export_state_interfaces () final
 A non-chainable controller doesn't export any state interfaces.
 
std::vector< hardware_interface::CommandInterface::SharedPtr > export_reference_interfaces () final
 Controller has no reference interfaces.
 
bool set_chained_mode (bool chained_mode) final
 Controller is not chainable, therefore no chained mode can be set.
 
bool is_in_chained_mode () const final
 Controller can not be in chained mode.
 
- Public Member Functions inherited from controller_interface::ControllerInterfaceBase
virtual void assign_interfaces (std::vector< hardware_interface::LoanedCommandInterface > &&command_interfaces, std::vector< hardware_interface::LoanedStateInterface > &&state_interfaces)
 Method that assigns the Loaned interfaces to the controller.
 
virtual void release_interfaces ()
 Method that releases the Loaned interfaces from the controller.
 
return_type init (const std::string &controller_name, const std::string &urdf, unsigned int cm_update_rate, const std::string &node_namespace, const rclcpp::NodeOptions &node_options)
 
return_type init (const controller_interface::ControllerInterfaceParams &params)
 
const rclcpp_lifecycle::State & configure ()
 Custom configure method to read additional parameters for controller-nodes.
 
ControllerUpdateStatus trigger_update (const rclcpp::Time &time, const rclcpp::Duration &period)
 Trigger update method. This method is used by the controller_manager to trigger the update method of the controller. The method is used to trigger the update method of the controller synchronously or asynchronously, based on the controller configuration. The method called in the (real-time) control loop.
 
std::shared_ptr< rclcpp_lifecycle::LifecycleNode > get_node ()
 
std::shared_ptr< const rclcpp_lifecycle::LifecycleNode > get_node () const
 
const rclcpp_lifecycle::State & get_lifecycle_state () const
 Get the current lifecycle state of the controller node.
 
uint8_t get_lifecycle_id () const
 Get the lifecycle id of the controller node that is cached internally to avoid calls to get_lifecycle_state() in the real-time control loop.
 
unsigned int get_update_rate () const
 
bool is_async () const
 
const std::string & get_robot_description () const
 
const std::unordered_map< std::string, joint_limits::JointLimits > & get_hard_joint_limits () const
 Get the unordered map of joint limits that are defined in the robot description.
 
const std::unordered_map< std::string, joint_limits::SoftJointLimits > & get_soft_joint_limits () const
 Get the unordered map of soft joint limits that are defined in the robot description.
 
virtual rclcpp::NodeOptions define_custom_node_options () const
 Method used by the controller_manager for base NodeOptions to instantiate the Lifecycle node of the controller upon loading the controller.
 
template<typename ParameterT >
auto auto_declare (const std::string &name, const ParameterT &default_value)
 Declare and initialize a parameter with a type.
 
void wait_for_trigger_update_to_finish ()
 Method to wait for any running async update cycle to finish after finishing the current cycle. This is needed to be called before deactivating the controller by the controller_manager, so that the interfaces still exist when the controller finishes its cycle and then it's exits.
 
void prepare_for_deactivation ()
 Method to prepare the controller for deactivation. This method is called by the controller manager before deactivating the controller. The method is used to prepare the controller for deactivation, e.g., to stop triggering the update cycles further. This method is especially needed for controllers running in async mode and different frequency than the control manager.
 
std::string get_name () const
 
void enable_introspection (bool enable)
 Enable or disable introspection of the controller.
 

Additional Inherited Members

- Protected Member Functions inherited from forward_command_controller::ForwardCommandController
void declare_parameters () override
 
controller_interface::CallbackReturn read_parameters () override
 
- Protected Attributes inherited from forward_command_controller::ForwardCommandController
std::shared_ptr< ParamListener > param_listener_
 
Params params_
 
- Protected Attributes inherited from forward_command_controller::ForwardControllersBase
std::vector< std::string > joint_names_
 
std::string interface_name_
 
std::vector< std::string > command_interface_types_
 
realtime_tools::RealtimeThreadSafeBox< CmdType > rt_command_
 
CmdType joint_commands_
 
rclcpp::Subscription< CmdType >::SharedPtr joints_command_subscriber_
 
- Protected Attributes inherited from controller_interface::ControllerInterfaceBase
std::vector< hardware_interface::LoanedCommandInterfacecommand_interfaces_
 Loaned command interfaces.
 
std::vector< hardware_interface::LoanedStateInterfacestate_interfaces_
 Loaned state interfaces.
 
pal_statistics::RegistrationsRAII stats_registrations_
 

Detailed Description

Forward command controller for a set of effort controlled joints (linear or angular).

This class forwards the commanded efforts down to a set of joints.

Parameters
jointsNames of the joints to control.

Subscribes to:

Member Function Documentation

◆ on_init()

controller_interface::CallbackReturn effort_controllers::JointGroupEffortController::on_init ( )
overridevirtual

Extending interface with initialization method which is individual for each controller.

Reimplemented from forward_command_controller::ForwardControllersBase.


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