#include <handle.hpp>

Inheritance diagram for transmission_interface::JointHandle:

Collaboration diagram for transmission_interface::JointHandle:

[legend]

Additional Inherited Members
Public Member Functions inherited from hardware_interface::Handle
	Handle (const std::string &prefix_name, const std::string &interface_name, double *value_ptr=nullptr)

	Handle (const InterfaceDescription &interface_description)

	Handle (const std::string &interface_name)

	Handle (const char *interface_name)

	Handle (const Handle &other) noexcept

Handle &	operator= (const Handle &other)

	Handle (Handle &&other) noexcept

Handle &	operator= (Handle &&other)

	operator bool () const
	Returns true if handle references a value.

const std::string &	get_name () const

const std::string &	get_interface_name () const

const std::string &	get_full_name () const

const std::string &	get_prefix_name () const

double	get_value () const

template<typename T = double>
std::optional< T >	get_optional () const
	Get the value of the handle.

template<typename T = double>
std::optional< T >	get_optional (std::shared_lock< std::shared_mutex > &lock) const
	Get the value of the handle.

template<typename T >
bool	get_value (T &value) const
	Get the value of the handle.

template<typename T >
bool	set_value (const T &value)
	Set the value of the handle.

template<typename T >
bool	set_value (std::unique_lock< std::shared_mutex > &lock, const T &value)
	Set the value of the handle.

std::shared_mutex &	get_mutex () const

HandleDataType	get_data_type () const

Protected Attributes inherited from hardware_interface::Handle
std::string	prefix_name_

std::string	interface_name_

std::string	handle_name_

HANDLE_DATATYPE	value_ = std::monostate{}

HandleDataType	data_type_ = HandleDataType::DOUBLE

double *	value_ptr_

std::shared_mutex	handle_mutex_

Detailed Description

A handle used to get and set a value on a given joint interface.

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

ros2_control/transmission_interface/include/transmission_interface/handle.hpp

Additional Inherited Members

Detailed Description