On this page
article
peary::hal::SwitchStatus
peary::hal::SwitchStatus
A resource which can read the status of a switch.
#include <peary/hal/Resources.hpp>
Inherits from peary::hal::Resource
Public Functions
| Name | |
|---|---|
| virtual bool | getSwitch() =0Read the switch status this resource has access to. |
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 getSwitch
virtual bool getSwitch() =0
Read the switch status this resource has access to.
Return: Boolean indicating the status of the switch
Purely virtual function to be implemented by the actual resource class
Updated on 2025-11-14 at 11:31:23 +0100