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(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 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 2025-11-14 at 11:31:23 +0100