tap::sensors::DistanceSensor Class Reference

#include <distance_sensor.hpp>

Inheritance diagram for tap::sensors::DistanceSensor:

Public Member Functions
	DistanceSensor (float minDistance, float maxDistance)
virtual	~DistanceSensor ()=default
virtual void	init ()=0
virtual float	read ()=0
virtual bool	validReading () const =0
float	getMinDistance () const
float	getMaxDistance () const
float	getDistance () const

Protected Attributes
float	distance
	Distance from sensor.
float	minDistance
	Lower boundary for reliable readings.
float	maxDistance
	Upper boundary for reliable readings.

Constructor & Destructor Documentation

DistanceSensor()

tap::sensors::DistanceSensor::DistanceSensor	(	float	minDistance,
		float	maxDistance
	)

Constructor to init boundaries.

Parameters

[in]	minDistance	the min valid distance.
[in]	maxDistance	the max valid distance.

~DistanceSensor()

virtual tap::sensors::DistanceSensor::~DistanceSensor ( )

virtualdefault

Member Function Documentation

getDistance()

float tap::sensors::DistanceSensor::getDistance

(

)

const

Get the current distance.

getMaxDistance()

float tap::sensors::DistanceSensor::getMaxDistance

(

)

const

Get maximun distance boundary.

getMinDistance()

float tap::sensors::DistanceSensor::getMinDistance

(

)

const

Get minumum distance boundary.

init()

virtual void tap::sensors::DistanceSensor::init ( )

pure virtual

Implemented in tap::sensors::SharpIrGP2Y0A41.

read()

virtual float tap::sensors::DistanceSensor::read ( )

pure virtual

Read sensor and updates current distance.

Implemented in tap::sensors::AnalogDistanceSensor.

validReading()

virtual bool tap::sensors::DistanceSensor::validReading ( ) const

pure virtual

Checks if current reading is within bounds.

Implemented in tap::sensors::AnalogDistanceSensor.

Member Data Documentation

distance

float tap::sensors::DistanceSensor::distance

protected

Distance from sensor.

maxDistance

float tap::sensors::DistanceSensor::maxDistance

protected

Upper boundary for reliable readings.

minDistance

float tap::sensors::DistanceSensor::minDistance

protected

Lower boundary for reliable readings.

---

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

• fang-mcb-project/taproot/src/tap/communication/sensors/distance/distance_sensor.hpp
• fang-mcb-project/taproot/src/tap/communication/sensors/distance/distance_sensor.cpp