Inheritance diagram for hardware_interface::StateInterface:

Collaboration diagram for hardware_interface::StateInterface:

[legend]

Public Types
using	SharedPtr = std::shared_ptr< StateInterface >

using	ConstSharedPtr = std::shared_ptr< const StateInterface >

Public Member Functions
	StateInterface (const InterfaceDescription &interface_description)

void	registerIntrospection () const

void	unregisterIntrospection () const

	StateInterface (const StateInterface &other)=default

	StateInterface (StateInterface &&other)=default

	Handle (const std::string &prefix_name, const std::string &interface_name, double *value_ptr)

	Handle (const std::string &prefix_name, const std::string &interface_name, const std::string &data_type="double", const std::string &initial_value="")

	Handle (const InterfaceDescription &interface_description)

	Handle (const std::string &interface_name)

	Handle (const char *interface_name)

	Handle (const Handle &other) noexcept

	Handle (Handle &&other) noexcept

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

	Handle (const std::string &prefix_name, const std::string &interface_name, const std::string &data_type="double", const std::string &initial_value="")

	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_prefix_name () 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	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

bool	is_castable_to_double () const
	Returns true if the handle data type can be casted to double.

Additional Inherited Members
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_

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

ros2_control/hardware_interface/include/hardware_interface/handle.hpp

Public Types

Public Member Functions

Additional Inherited Members