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(std::string_view name)Set the name of the resource, usually corresponds to the name used in the schematic.
std::string name() constGet the name of the resource.
void setType(std::string_view type)Set the type string (e.g. VoltageRegulator)
std::string type() constGet the type of the resource.

Protected Attributes inherited from peary::hal::Resource

Name
std::string _name
std::string _type

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 2026-01-30 at 22:01:05 +0100