okapi::AbstractMotor::GearsetRatioPair Struct Reference

A simple structure representing the full ratio between motor and wheel. More...

#include <abstractMotor.hpp>

Public Member Functions
	GearsetRatioPair (const gearset igearset, const double iratio=1)
	A simple structure representing the full ratio between motor and wheel.
	~GearsetRatioPair ()=default

Public Attributes
gearset	internalGearset
double	ratio = 1

Detailed Description

A simple structure representing the full ratio between motor and wheel.

Definition at line 48 of file abstractMotor.hpp.

Constructor & Destructor Documentation

GearsetRatioPair()

okapi::AbstractMotor::GearsetRatioPair::GearsetRatioPair ( const gearset  igearset, const double  iratio = 1  )

inline

A simple structure representing the full ratio between motor and wheel.

The ratio is motor rotation : wheel rotation, e.x., if one motor rotation corresponds to two wheel rotations, the ratio is 1.0/2.0.

Parameters

igearset	The gearset in the motor.
iratio	The ratio of motor rotation to wheel rotation.

Definition at line 58 of file abstractMotor.hpp.

~GearsetRatioPair()

okapi::AbstractMotor::GearsetRatioPair::~GearsetRatioPair ( )

default

Member Data Documentation

internalGearset

gearset okapi::AbstractMotor::GearsetRatioPair::internalGearset

Definition at line 64 of file abstractMotor.hpp.

ratio

double okapi::AbstractMotor::GearsetRatioPair::ratio = 1

Definition at line 65 of file abstractMotor.hpp.

---

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

• include/okapi/api/device/motor/abstractMotor.hpp