Inheritance diagram for ros2_control_demo_example_14::RRBotSensorPositionFeedback:

[legend]

Collaboration diagram for ros2_control_demo_example_14::RRBotSensorPositionFeedback:

[legend]

Public Member Functions
hardware_interface::CallbackReturn	on_init (const hardware_interface::HardwareInfo &info) override
	Initialization of the hardware interface from data parsed from the robot's URDF.

hardware_interface::CallbackReturn	on_configure (const rclcpp_lifecycle::State &previous_state) override

hardware_interface::CallbackReturn	on_activate (const rclcpp_lifecycle::State &previous_state) override

hardware_interface::CallbackReturn	on_deactivate (const rclcpp_lifecycle::State &previous_state) override

hardware_interface::CallbackReturn	on_shutdown (const rclcpp_lifecycle::State &previous_state) override

hardware_interface::return_type	read (const rclcpp::Time &time, const rclcpp::Duration &period) override
	Read the current state values from the actuator.

Public Member Functions inherited from hardware_interface::SensorInterface
	SensorInterface (const SensorInterface &other)=delete
	SensorInterface copy constructor is actively deleted.

	SensorInterface (SensorInterface &&other)=delete

CallbackReturn	init (const HardwareInfo &hardware_info, rclcpp::Logger logger, rclcpp::node_interfaces::NodeClockInterface::SharedPtr clock_interface)

CallbackReturn	init (const HardwareInfo &hardware_info, rclcpp::Logger logger, rclcpp::Clock::SharedPtr clock)

virtual std::vector< StateInterface >	export_state_interfaces ()
	Exports all state interfaces for this hardware interface.

virtual std::vector< hardware_interface::InterfaceDescription >	export_unlisted_state_interface_descriptions ()

virtual std::vector< StateInterface::ConstSharedPtr >	on_export_state_interfaces ()

HardwareComponentCycleStatus	trigger_read (const rclcpp::Time &time, const rclcpp::Duration &period)
	Triggers the read method synchronously or asynchronously depending on the HardwareInfo.

const std::string &	get_name () const
	Get name of the actuator hardware.

const std::string &	get_group_name () const
	Get name of the actuator hardware group to which it belongs to.

const rclcpp_lifecycle::State &	get_lifecycle_state () const
	Get life-cycle state of the actuator hardware.

void	set_lifecycle_state (const rclcpp_lifecycle::State &new_state)
	Set life-cycle state of the actuator hardware.

template<typename T >
void	set_state (const std::string &interface_name, const T &value)

template<typename T = double>
T	get_state (const std::string &interface_name) const

rclcpp::Logger	get_logger () const
	Get the logger of the SensorInterface.

rclcpp::Clock::SharedPtr	get_clock () const
	Get the clock of the SensorInterface.

const HardwareInfo &	get_hardware_info () const
	Get the hardware info of the SensorInterface.

void	enable_introspection (bool enable)
	Enable or disable introspection of the sensor hardware.

Additional Inherited Members
Protected Attributes inherited from hardware_interface::SensorInterface
HardwareInfo	info_

std::unordered_map< std::string, InterfaceDescription >	joint_state_interfaces_

std::unordered_map< std::string, InterfaceDescription >	sensor_state_interfaces_

std::unordered_map< std::string, InterfaceDescription >	unlisted_state_interfaces_

std::vector< StateInterface::SharedPtr >	joint_states_

std::vector< StateInterface::SharedPtr >	sensor_states_

std::vector< StateInterface::SharedPtr >	unlisted_states_

rclcpp_lifecycle::State	lifecycle_state_

std::unique_ptr< realtime_tools::AsyncFunctionHandler< return_type > >	read_async_handler_

pal_statistics::RegistrationsRAII	stats_registrations_

Member Function Documentation

◆ on_init()

hardware_interface::CallbackReturn ros2_control_demo_example_14::RRBotSensorPositionFeedback::on_init ( const hardware_interface::HardwareInfo & hardware_info )

overridevirtual

Initialization of the hardware interface from data parsed from the robot's URDF.

Parameters

[in] hardware_info structure with data from URDF.

Returns: CallbackReturn::SUCCESS if required data are provided and can be parsed.; CallbackReturn::ERROR if any error happens or data are missing.

Reimplemented from hardware_interface::SensorInterface.

◆ read()

hardware_interface::return_type ros2_control_demo_example_14::RRBotSensorPositionFeedback::read	(	const rclcpp::Time &	time,
		const rclcpp::Duration &	period
	)

overridevirtual

Read the current state values from the actuator.

The data readings from the physical hardware has to be updated and reflected accordingly in the exported state interfaces. That is, the data pointed by the interfaces shall be updated.

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 the read was successful, return_type::ERROR otherwise.

Implements hardware_interface::SensorInterface.

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

ros2_control_demos/example_14/hardware/include/ros2_control_demo_example_14/rrbot_sensor_for_position_feedback.hpp
ros2_control_demos/example_14/hardware/rrbot_sensor_for_position_feedback.cpp

Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ on_init()

◆ read()