peary::hal::SwitchControl
peary::hal::SwitchControl
A resource which can control a switch.
#include <peary/hal/Resources.hpp>
Inherits from peary::hal::Resource
Inherited by peary::board::carboard::BiasRegulator, peary::board::carboard::CMOSLevels, peary::board::carboard::CurrentSource, peary::board::carboard::VoltageRegulator
Public Functions
| Name | |
|---|---|
| virtual void | setSwitch(bool enable) =0Enables or disables the switch this resource controls. |
Additional inherited members
Public Functions inherited from peary::hal::Resource
| Name | |
|---|---|
| virtual | ~Resource() =defaultDefault constructor. |
| void | setName(const std::string & name)Set the name of the resource. |
| std::string | name() constGet the name of the resource. |
Protected Attributes inherited from peary::hal::Resource
| Name | |
|---|---|
| std::string | _name |
Public Functions Documentation
function setSwitch
virtual void setSwitch(
bool enable
) =0
Enables or disables the switch this resource controls.
Parameters:
- enable Boolean to indicate whether to enable or disable the switch
Reimplemented by: peary::board::carboard::BiasRegulator::setSwitch, peary::board::carboard::CMOSLevels::setSwitch, peary::board::carboard::CurrentSource::setSwitch, peary::board::carboard::VoltageRegulator::setSwitch
Purely virtual function to be implemented by the actual resource class
Updated on 2025-11-14 at 11:31:23 +0100