ros2_control - rolling
Public Types | Public Member Functions | List of all members
hardware_interface::CommandInterface Class Reference
Inheritance diagram for hardware_interface::CommandInterface:
Inheritance graph
[legend]
Collaboration diagram for hardware_interface::CommandInterface:
Collaboration graph
[legend]

Public Types

using SharedPtr = std::shared_ptr< CommandInterface >
 

Public Member Functions

 CommandInterface (const InterfaceDescription &interface_description)
 
 CommandInterface (const CommandInterface &other)=delete
 CommandInterface copy constructor is actively deleted. More...
 
 CommandInterface (CommandInterface &&other)=default
 
 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 (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=nullptr)
 
 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
 
Handleoperator= (const Handle &other)
 
Handleoperator= (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
 
bool get_value (double &value) const
 
bool set_value (double value)
 

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_
 
double * value_ptr_
 
std::shared_mutex handle_mutex_
 

Constructor & Destructor Documentation

◆ CommandInterface()

hardware_interface::CommandInterface::CommandInterface ( const CommandInterface other)
delete

CommandInterface copy constructor is actively deleted.

Command interfaces are having a unique ownership and thus can't be copied in order to avoid simultaneous writes to the same resource.


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