controls  3.0.0
Public Member Functions | List of all members
ThrusterLookupInterface Class Referenceabstract

Abstract interface for voltage-dependent thruster lookup tables. More...

#include <ThrusterLookupInterface.h>

Public Member Functions

virtual ~ThrusterLookupInterface ()=default
 
virtual std::pair< float, float > getForceLimits (float voltage_v)=0
 Returns the minimum and maximum achievable thrust at a given voltage. More...
 
virtual int16_t getThrusterCommand (float thrust_N, float voltage_v)=0
 Converts a desired thrust and voltage to a thruster command value. More...
 

Detailed Description

Abstract interface for voltage-dependent thruster lookup tables.

Implementations map a desired thrust force (N) at a given battery voltage (V) to an integer PWM-style command, and expose the achievable force limits at that voltage.

Constructor & Destructor Documentation

◆ ~ThrusterLookupInterface()

virtual ThrusterLookupInterface::~ThrusterLookupInterface ( )
virtualdefault

Member Function Documentation

◆ getForceLimits()

virtual std::pair<float, float> ThrusterLookupInterface::getForceLimits ( float  voltage_v)
pure virtual

Returns the minimum and maximum achievable thrust at a given voltage.

Parameters
voltage_v[in] Battery voltage in volts
Returns
Pair of (min_force_N, max_force_N)

◆ getThrusterCommand()

virtual int16_t ThrusterLookupInterface::getThrusterCommand ( float  thrust_N,
float  voltage_v 
)
pure virtual

Converts a desired thrust and voltage to a thruster command value.

Parameters
thrust_N[in] Desired thrust in Newtons
voltage_v[in] Battery voltage in volts
Returns
Integer thruster command (e.g. PWM microseconds or a scaled value)

The documentation for this class was generated from the following file: