Speed Class Reference

Represents a speed measurement with unit conversion support. More...

#include <Speed.h>

Public Member Functions
	Speed (float speed, SpeedUnit unit)
void	setValue (float newSpeed, SpeedUnit newUnit)
float	getValue (SpeedUnit desiredUnit) const
Speed	operator+ (const Speed &other) const
Speed	operator- (const Speed &other) const
Speed	operator* (float scalar) const
Speed	operator/ (float scalar) const
bool	operator== (const Speed &other) const
bool	operator!= (const Speed &other) const
bool	operator< (const Speed &other) const
bool	operator<= (const Speed &other) const
bool	operator> (const Speed &other) const
bool	operator>= (const Speed &other) const
Speed &	operator+= (const Speed &other)
Speed &	operator-= (const Speed &other)
Speed &	operator*= (float scalar)
Speed &	operator/= (float scalar)

Protected Attributes
float	speed = 0.0f
SpeedUnit	unit = SpeedUnit::MPS
	Unit of the speed.

Detailed Description

Represents a speed measurement with unit conversion support.

The Speed class encapsulates a speed value and its unit, supporting meters per second (MPS), kilometers per hour (KPH), feet per second (FPS), and miles per hour (MPH). It provides methods to set and retrieve the speed in any supported unit, automatically handling conversions.

• Internal state is always consistent with the last set value and unit.
• Designed for embedded and robotics applications where unit flexibility and efficiency are required.
• Use getValue() to retrieve the speed in any unit; use setValue() to update the value and unit.

Example:

Speed s(10.0, SpeedUnit::MPS);
float mph = s.getValue(SpeedUnit::MPH); // Convert to miles per hour
s.setValue(36.0, SpeedUnit::KPH);       // Update value in km/h
float mps = s.getValue(SpeedUnit::MPS); // Convert back to m/s

Note

Invalid conversions return -1.0f.

See also

SpeedUnit

Member Data Documentation

unit

SpeedUnit unit = SpeedUnit::MPS

protected

Unit of the speed.

See also

SpeedUnit

---

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

• src/TinyRobotics/units/Speed.h