Skip to content

Commit

Permalink
Add docs in export interface configurations for controllers. (#804)
Browse files Browse the repository at this point in the history
  • Loading branch information
destogl authored Sep 28, 2022
1 parent 1088ac2 commit 81b8df6
Showing 1 changed file with 28 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,37 @@ class ControllerInterfaceBase : public rclcpp_lifecycle::node_interfaces::Lifecy
CONTROLLER_INTERFACE_PUBLIC
virtual ~ControllerInterfaceBase() = default;

/// Get configuration for controller's required command interfaces.
/**
* Method used by the controller_manager to get the set of command interfaces used by the controller.
* Each controller can use individual method to determine interface names that in simples case
* have the following format: `<joint>/<interface>`.
* The method is called only in `inactive` or `active` state, i.e., `on_configure` has to be
* called first.
* The configuration is used to check if controller can be activated and to claim interfaces from
* hardware.
* The claimed interfaces are populated in the
* \ref ControllerInterfaceBase::command_interfaces_ "command_interfaces_" member.
*
* \returns configuration of command interfaces.
*/
CONTROLLER_INTERFACE_PUBLIC
virtual InterfaceConfiguration command_interface_configuration() const = 0;

/// Get configuration for controller's required state interfaces.
/**
* Method used by the controller_manager to get the set of state interface used by the controller.
* Each controller can use individual method to determine interface names that in simples case
* have the following format: `<joint>/<interface>`.
* The method is called only in `inactive` or `active` state, i.e., `on_configure` has to be
* called first.
* The configuration is used to check if controller can be activated and to claim interfaces from
* hardware.
* The claimed interfaces are populated in the
* \ref ControllerInterfaceBase::state_interface_ "state_interface_" member.
*
* \returns configuration of state interfaces.
*/
CONTROLLER_INTERFACE_PUBLIC
virtual InterfaceConfiguration state_interface_configuration() const = 0;

Expand Down

0 comments on commit 81b8df6

Please sign in to comment.