roo_control
API Documentation for roo_control
Loading...
Searching...
No Matches
roo_control::BoundSwitch< BinaryLogicalState > Class Reference

BinaryLogicalState specialization with stricter value checks. More...

#include <bound_switch.h>

Inheritance diagram for roo_control::BoundSwitch< BinaryLogicalState >:
[legend]
Collaboration diagram for roo_control::BoundSwitch< BinaryLogicalState >:
[legend]

Public Member Functions

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

Detailed Description

BinaryLogicalState specialization with stricter value checks.

Definition at line 43 of file bound_switch.h.

Constructor & Destructor Documentation

◆ BoundSwitch()

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

Definition at line 45 of file bound_switch.h.

Member Function Documentation

◆ getState()

bool roo_control::BoundSwitch< BinaryLogicalState >::getState ( BinaryLogicalState result) const
inlineoverride

Definition at line 49 of file bound_switch.h.

◆ setState()

bool roo_control::BoundSwitch< BinaryLogicalState >::setState ( BinaryLogicalState  state)
inlineoverridevirtual

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

Implements roo_control::Switch< BinaryLogicalState >.

Definition at line 70 of file bound_switch.h.


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