gpio_controllers::GpioCommandController Class Reference

Inheritance diagram for gpio_controllers::GpioCommandController:

Collaboration diagram for gpio_controllers::GpioCommandController:

Public Member Functions
GPIO_COMMAND_CONTROLLER_PUBLIC controller_interface::InterfaceConfiguration	command_interface_configuration () const override
	Get configuration for controller's required command interfaces.
GPIO_COMMAND_CONTROLLER_PUBLIC controller_interface::InterfaceConfiguration	state_interface_configuration () const override
	Get configuration for controller's required state interfaces.
GPIO_COMMAND_CONTROLLER_PUBLIC CallbackReturn	on_init () override
	Extending interface with initialization method which is individual for each controller.
GPIO_COMMAND_CONTROLLER_PUBLIC CallbackReturn	on_configure (const rclcpp_lifecycle::State &previous_state) override
GPIO_COMMAND_CONTROLLER_PUBLIC CallbackReturn	on_activate (const rclcpp_lifecycle::State &previous_state) override
GPIO_COMMAND_CONTROLLER_PUBLIC CallbackReturn	on_deactivate (const rclcpp_lifecycle::State &previous_state) override
GPIO_COMMAND_CONTROLLER_PUBLIC controller_interface::return_type	update (const rclcpp::Time &time, const rclcpp::Duration &period) override
Public Member Functions inherited from controller_interface::ControllerInterface
CONTROLLER_INTERFACE_PUBLIC bool	is_chainable () const final
CONTROLLER_INTERFACE_PUBLIC std::vector< hardware_interface::CommandInterface >	export_reference_interfaces () final
CONTROLLER_INTERFACE_PUBLIC bool	set_chained_mode (bool chained_mode) final
CONTROLLER_INTERFACE_PUBLIC bool	is_in_chained_mode () const final
Public Member Functions inherited from controller_interface::ControllerInterfaceBase
CONTROLLER_INTERFACE_PUBLIC void	assign_interfaces (std::vector< hardware_interface::LoanedCommandInterface > &&command_interfaces, std::vector< hardware_interface::LoanedStateInterface > &&state_interfaces)
CONTROLLER_INTERFACE_PUBLIC void	release_interfaces ()
virtual CONTROLLER_INTERFACE_PUBLIC return_type	init (const std::string &controller_name, const std::string &namespace_="", const rclcpp::NodeOptions &node_options=rclcpp::NodeOptions() .allow_undeclared_parameters(true) .automatically_declare_parameters_from_overrides(true))
CONTROLLER_INTERFACE_PUBLIC const rclcpp_lifecycle::State &	configure ()
	Custom configure method to read additional parameters for controller-nodes.
CONTROLLER_INTERFACE_PUBLIC std::shared_ptr< rclcpp_lifecycle::LifecycleNode >	get_node ()
CONTROLLER_INTERFACE_PUBLIC std::shared_ptr< rclcpp_lifecycle::LifecycleNode >	get_node () const
CONTROLLER_INTERFACE_PUBLIC const rclcpp_lifecycle::State &	get_state () const
CONTROLLER_INTERFACE_PUBLIC unsigned int	get_update_rate () const
template<typename ParameterT >
auto	auto_declare (const std::string &name, const ParameterT &default_value)
	Declare and initialize a parameter with a type.

Protected Attributes
InterfacesNames	command_interface_types_
InterfacesNames	state_interface_types_
MapOfReferencesToCommandInterfaces	command_interfaces_map_
MapOfReferencesToStateInterfaces	state_interfaces_map_
realtime_tools::RealtimeBuffer< std::shared_ptr< CmdType > >	rt_command_ptr_ {}
rclcpp::Subscription< CmdType >::SharedPtr	gpios_command_subscriber_ {}
std::shared_ptr< rclcpp::Publisher< StateType > >	gpio_state_publisher_ {}
std::shared_ptr< realtime_tools::RealtimePublisher< StateType > >	realtime_gpio_state_publisher_ {}
std::shared_ptr< gpio_command_controller_parameters::ParamListener >	param_listener_ {}
gpio_command_controller_parameters::Params	params_
Protected Attributes inherited from controller_interface::ControllerInterfaceBase
std::vector< hardware_interface::LoanedCommandInterface >	command_interfaces_
std::vector< hardware_interface::LoanedStateInterface >	state_interfaces_
unsigned int	update_rate_ = 0

Member Function Documentation

command_interface_configuration()

controller_interface::InterfaceConfiguration gpio_controllers::GpioCommandController::command_interface_configuration ( ) const

overridevirtual

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 command_interfaces_ member.

Returns

configuration of command interfaces.

Implements controller_interface::ControllerInterfaceBase.

on_init()

CallbackReturn gpio_controllers::GpioCommandController::on_init ( )

overridevirtual

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

Implements controller_interface::ControllerInterfaceBase.

state_interface_configuration()

controller_interface::InterfaceConfiguration gpio_controllers::GpioCommandController::state_interface_configuration ( ) const

overridevirtual

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 state_interface_ member.

Returns

configuration of state interfaces.

Implements controller_interface::ControllerInterfaceBase.

update()

controller_interface::return_type gpio_controllers::GpioCommandController::update ( const rclcpp::Time &  time, const rclcpp::Duration &  period  )

overridevirtual

Control step update. Command interfaces are updated based on on reference inputs and current states. The method called in the (real-time) control loop.

Parameters

[in]	time	The time at the start of this control loop iteration
[in]	period	The measured time taken by the last control loop iteration

Returns

return_type::OK if update is successfully, otherwise return_type::ERROR.

Implements controller_interface::ControllerInterfaceBase.

---

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

• ros2_controllers/gpio_controllers/include/gpio_controllers/gpio_command_controller.hpp
• ros2_controllers/gpio_controllers/src/gpio_command_controller.cpp