Class Handle

• Defined in File handle.hpp

Inheritance Relationships

Derived Types

• public hardware_interface::CommandInterface (Class CommandInterface)

• public hardware_interface::StateInterface (Class StateInterface)

Class Documentation

class Handle

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

Subclassed by hardware_interface::CommandInterface, hardware_interface::StateInterface

Public Functions

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

inline explicit Handle(const InterfaceDescription &interface_description)

inline explicit Handle(const std::string &interface_name)

inline explicit Handle(const char *interface_name)

inline Handle(const Handle &other) noexcept

inline Handle(Handle &&other) noexcept

inline Handle &operator=(const Handle &other)

inline Handle &operator=(Handle &&other)

virtual ~Handle() = default

inline operator bool() const

Returns true if handle references a value.

inline const std::string &get_name() const

inline const std::string &get_interface_name() const

inline const std::string &get_full_name() const

inline const std::string &get_prefix_name() const

inline double get_value() const

inline bool get_value(double &value) const

inline bool set_value(double value)

Protected Attributes

std::string prefix_name_

std::string interface_name_

std::string handle_name_

HANDLE_DATATYPE value_

double *value_ptr_

mutable std::shared_mutex handle_mutex_