Class CommandInterface

Inheritance Relationships

Base Type

Class Documentation

class CommandInterface : public hardware_interface::Handle

Public Types

using SharedPtr = std::shared_ptr<CommandInterface>

Public Functions

inline explicit CommandInterface(const InterfaceDescription &interface_description)
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.

CommandInterface(CommandInterface &&other) = default
inline void set_on_set_command_limiter(std::function<double(double, bool&)> on_set_command_limiter)
template<typename T>
inline bool set_limited_value(const T &value)

A setter for the value of the command interface that triggers the limiter.

Parameters:

value – The value to be set.

Returns:

True if the value was set successfully, false otherwise.

inline const bool &is_limited() const
inline void registerIntrospection() const
inline void unregisterIntrospection() const
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