peary::hal::CurrentControl

A resource which can control a current source.

#include <peary/hal/Resources.hpp>

Inherits from peary::hal::Resource

Inherited by peary::board::carboard::CurrentSource

Public Functions

Name
virtual void setCurrent(double current) =0Set the current this resource controls.
virtual void setPolarity(utils::Polarity polarity) =0Set the polarity of the current 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 setCurrent 

  virtual void setCurrent(
    double current
) =0

Set the current this resource controls.

Parameters:

  • current Current to be set

Reimplemented by: peary::board::carboard::CurrentSource::setCurrent

Purely virtual function to be implemented by the actual resource class

function setPolarity 

  virtual void setPolarity(
    utils::Polarity polarity
) =0

Set the polarity of the current this resource controls.

Parameters:

  • polarity Polarity of the current to be set

Reimplemented by: peary::board::carboard::CurrentSource::setPolarity

Purely virtual function to be implemented by the actual resource class

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