ROS2 Control
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 Member Functions

 CommandInterface (const CommandInterface &other)=delete
 CommandInterface copy constructor is actively deleted. More...
 
 CommandInterface (CommandInterface &&other)=default
 
 ReadWriteHandle (const std::string &prefix_name, const std::string &interface_name, double *value_ptr=nullptr)
 
 ReadWriteHandle (const std::string &interface_name)
 
 ReadWriteHandle (const char *interface_name)
 
 ReadWriteHandle (const ReadWriteHandle &other)=default
 
 ReadWriteHandle (ReadWriteHandle &&other)=default
 
- Public Member Functions inherited from hardware_interface::ReadWriteHandle
 ReadWriteHandle (const std::string &prefix_name, const std::string &interface_name, double *value_ptr=nullptr)
 
 ReadWriteHandle (const std::string &interface_name)
 
 ReadWriteHandle (const char *interface_name)
 
 ReadWriteHandle (const ReadWriteHandle &other)=default
 
 ReadWriteHandle (ReadWriteHandle &&other)=default
 
ReadWriteHandleoperator= (const ReadWriteHandle &other)=default
 
ReadWriteHandleoperator= (ReadWriteHandle &&other)=default
 
void set_value (double value)
 
- Public Member Functions inherited from hardware_interface::ReadOnlyHandle
 ReadOnlyHandle (const std::string &prefix_name, const std::string &interface_name, double *value_ptr=nullptr)
 
 ReadOnlyHandle (const std::string &interface_name)
 
 ReadOnlyHandle (const char *interface_name)
 
 ReadOnlyHandle (const ReadOnlyHandle &other)=default
 
 ReadOnlyHandle (ReadOnlyHandle &&other)=default
 
ReadOnlyHandleoperator= (const ReadOnlyHandle &other)=default
 
ReadOnlyHandleoperator= (ReadOnlyHandle &&other)=default
 
 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
 

Additional Inherited Members

- Protected Attributes inherited from hardware_interface::ReadOnlyHandle
std::string prefix_name_
 
std::string interface_name_
 
double * value_ptr_
 

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: