peary::hal::CurrentLimiter

A resource which can control a voltage level.

#include <peary/hal/Resources.hpp>

Inherits from peary::hal::Resource

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

Public Functions

Name
virtual void setCurrentLimit(double current_limit) =0Set the voltage level this resource controls.

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 setCurrentLimit 

  virtual void setCurrentLimit(
    double current_limit
) =0

Set the voltage level this resource controls.

Parameters:

  • current_limit Current limit to be set

Reimplemented by: peary::board::carboard::VoltageRegulator::setCurrentLimit

Purely virtual function to be implemented by the actual resource class

Updated on 2026-01-30 at 22:01:05 +0100