Distance Class Reference

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

#include <Distance.h>

Public Member Functions
	Distance (float distance, DistanceUnit unit)
void	setValue (float newDistance, DistanceUnit newUnit)
float	getValue (DistanceUnit desiredUnit) const
Distance	operator+ (const Distance &other) const
Distance	operator- (const Distance &other) const
Distance	operator* (float scalar) const
Distance	operator/ (float scalar) const
bool	operator== (const Distance &other) const
bool	operator!= (const Distance &other) const
bool	operator< (const Distance &other) const
bool	operator<= (const Distance &other) const
bool	operator> (const Distance &other) const
bool	operator>= (const Distance &other) const
Distance &	operator+= (const Distance &other)
Distance &	operator-= (const Distance &other)
Distance &	operator*= (float scalar)
Distance &	operator/= (float scalar)

Protected Attributes
float	distance = 0.0f
DistanceUnit	unit = DistanceUnit::M
	Unit of the distance.

Detailed Description

Represents a distance measurement with unit conversion support.

The Distance class encapsulates a distance value and its unit, supporting meters (M), centimeters (CM), millimeters (MM), and feet (FEET). It provides methods to set and retrieve the distance 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 distance in any unit; use setValue() to update the value and unit.

Example:

Distance d(1.0, DistanceUnit::M);
float feet = d.getValue(DistanceUnit::FEET); // Convert to feet
d.setValue(100.0, DistanceUnit::CM);         // Update value in centimeters
float meters = d.getValue(DistanceUnit::M);  // Convert back to meters

Note

Invalid conversions return -1.0f.

See also

DistanceUnit

Member Data Documentation

unit

DistanceUnit unit = DistanceUnit::M

protected

Unit of the distance.

See also

DistanceUnit

---

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

• src/TinyRobotics/units/Distance.h