roo_control::BoundSwitch< State > Class Template Reference

Switch backed by a bound sensing actuator from roo_transceivers. More...

#include <bound_switch.h>

Inheritance diagram for roo_control::BoundSwitch< State >:

Collaboration diagram for roo_control::BoundSwitch< State >:

Public Member Functions
	BoundSwitch (roo_transceivers::Universe &universe, const roo_transceivers::ActuatorBinding *binding)
bool	getState (State &result) const override
	Retrieves the current state, or returns false when it cannot be read.
bool	setState (State state) override
	Updates the state of the switch. Returns true on success.
Public Member Functions inherited from roo_control::Switch< State >
virtual	~Switch ()=default
Public Member Functions inherited from roo_control::Selector< State >
virtual	~Selector ()=default

Detailed Description

template<typename State>
class roo_control::BoundSwitch< State >

Switch backed by a bound sensing actuator from roo_transceivers.

Definition at line 10 of file bound_switch.h.

Constructor & Destructor Documentation

BoundSwitch()

template<typename State >

roo_control::BoundSwitch< State >::BoundSwitch ( roo_transceivers::Universe &  universe, const roo_transceivers::ActuatorBinding *  binding  )

inline

Definition at line 12 of file bound_switch.h.

Member Function Documentation

getState()

template<typename State >

bool roo_control::BoundSwitch< State >::getState ( State &  result ) const

inlineoverridevirtual

Retrieves the current state, or returns false when it cannot be read.

Implements roo_control::Selector< State >.

Definition at line 16 of file bound_switch.h.

setState()

template<typename State >

bool roo_control::BoundSwitch< State >::setState ( State  state )

inlineoverridevirtual

Updates the state of the switch. Returns true on success.

Implements roo_control::Switch< State >.

Definition at line 33 of file bound_switch.h.

---

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

• temp_repos/roo_control/src/roo_control/switch/bound_switch.h