Template Class base_actuator

Inheritance Relationships

Base Types

  • public rer::client< base_actuator< TActuator > >

  • protected rpdecorator::decorator< TActuator >

Class Documentation

template<typename TActuator>
class base_actuator : public rer::client<base_actuator<TActuator>>, protected rpdecorator::decorator<TActuator>

Base actuator class to provide a common interface to all actuators.

Public Functions

base_actuator(base_actuator&&) = default
base_actuator(const base_actuator&) = default
inline explicit base_actuator(TActuator &&actuator)
inline base_actuator(void)
virtual ~base_actuator(void) = default
virtual void disable(void) = 0

Disable the actuator. Future commands to the actuator should either throw an error or do nothing (application dependent) until the actuator is re-enabled.Should do nothing if actuator is already disabled.

virtual void enable(void) = 0

Enable the actuator. Should do nothing if actuator is already enabled.

inline bool is_disabled(void) const
virtual bool is_enabled(void) const = 0

Is this actuator currently enabled?

base_actuator &operator=(base_actuator&&) = default
base_actuator &operator=(const base_actuator&) = default
virtual void reset(void) = 0

Reset the actuator to its initialized state.