YAMS
Yet Another Mechanism System
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
yams::math::SmartMath Class Reference

#include <SmartMath.hpp>

Public Member Functions

 SmartMath ()=delete
 

Static Public Member Functions

static double SensorToMechanismRatio (std::initializer_list< double > stages)
 
static double GearBox (std::initializer_list< double > stages)
 

Detailed Description

Utility class providing static helper methods for gearing calculations.

Cannot be instantiated.

Constructor & Destructor Documentation

◆ SmartMath()

yams::math::SmartMath::SmartMath ( )
delete

Member Function Documentation

◆ GearBox()

static double yams::math::SmartMath::GearBox ( std::initializer_list< double >  stages)
static

Compute the overall gear reduction ratio from a list of reduction stages.

Equivalent to SensorToMechanismRatio but named explicitly for gearbox calculations.

Parameters
stagesReduction stages.
Returns
Combined gear reduction factor.

◆ SensorToMechanismRatio()

static double yams::math::SmartMath::SensorToMechanismRatio ( std::initializer_list< double >  stages)
static

Compute the sensor-to-mechanism ratio from a list of reduction stages.

Each stage value is > 0, where a value greater than 1 indicates a speed reduction.

Parameters
stagesReduction stages (e.g. {10.0, 2.0} for a 20:1 total reduction).
Returns
Combined sensor-to-mechanism conversion factor.

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