peary::hal::CurrentProvider

A resource which can read a current value.

#include <peary/hal/Resources.hpp>

Inherits from peary::hal::Resource

Inherited by peary::board::carboard::VoltageRegulator

Public Functions

Name
virtual double getCurrent() =0Read the current 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 getCurrent 

  virtual double getCurrent() =0

Read the current this resource has access to.

Return: Current associated with this resource

Reimplemented by: peary::board::carboard::VoltageRegulator::getCurrent

Purely virtual function to be implemented by the actual resource class

Updated on 2025-11-14 at 11:31:23 +0100