DistanceSensor Interface Reference

A parent class for all sensors that conduct distance measurements. More...

#include <DistanceSensor.hpp>

Inheritance diagram for DistanceSensor:

Collaboration diagram for DistanceSensor:

Public Member Functions
virtual	~DistanceSensor ()=default
virtual unsigned int	getDistance ()=0
	Gets the distance measured by the sensor in centimeters.
virtual unsigned int	getMedianDistance (uint8_t iterations)=0
	Gets the median distance from the specified number of measurements.

Detailed Description

A parent class for all sensors that conduct distance measurements.

Definition at line 20 of file DistanceSensor.hpp.

Constructor & Destructor Documentation

~DistanceSensor()

virtual DistanceSensor::~DistanceSensor ( )

virtualdefault

Member Function Documentation

getDistance()

virtual unsigned int DistanceSensor::getDistance ( )

pure virtual

Gets the distance measured by the sensor in centimeters.

Calling this might trigger a new measurement by the sensor.

Returns

0 if an error has occured, otherwise the measured distance in centimeters

Example:

unsigned int distance = sensor.getDistance();

Implemented in GP2D120, GP2Y0A02, GP2Y0A21, SRF08, and SR04.

Here is the caller graph for this function:

getMedianDistance()

virtual unsigned int DistanceSensor::getMedianDistance ( uint8_t  iterations )

pure virtual

Gets the median distance from the specified number of measurements.

Parameters

iterations

Number of measurements to conduct (at most kMaxMedianMeasurements)

Returns

The median of the conducted measurements or an error value if the number of iterations is 0 or larger than kMaxMedianMeasurements

Example:

// Get the median of `10` measurements
unsigned int distance = sensor.getMedianDistance(10);

Implemented in InfraredAnalogSensor, SR04, and SRF08.

---

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

• src/sensors/distance/DistanceSensor.hpp