RoboidControl/RoboidControl-cpp
RoboidControl/RoboidControl-cpp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated documentation

Browse Source
This commit is contained in:
Pascal Serrarens 2023-11-23 15:55:55 +01:00
parent 8d3cfdfa51
commit 07254fd3ac
1 changed files with 15 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
DistanceSensor.h
View File

@ -2,32 +2,23 @@
#include "Sensor.h" #include "Sensor.h"
/// @brief A sensor which can measure the distance the the nearest object /// @brief A Sensor which can measure the distance to the nearest object
class DistanceSensor : public Sensor class DistanceSensor : public Sensor {
{ public:
public: DistanceSensor();
DistanceSensor(); // { isDistanceSensor = true; } DistanceSensor(float triggerDistance);
DistanceSensor(float triggerDistance); // { isDistanceSensor = true; this->triggerDistance = triggerDistance; } /// @brief Determine the distance to the nearest object
/// @brief Determine the distance to the nearest object /// @return the measured distance in meters to the nearest object
/// @return the measured distance in meters to the nearest object virtual float GetDistance();
virtual float GetDistance(); // { return distance; }; void SetDistance(float distance);
void SetDistance(float distance); // { this->distance = distance; }; // for simulation purposes
/// @brief The distance at which ObjectNearby triggers /// @brief The distance at which ObjectNearby triggers
float triggerDistance = 1; float triggerDistance = 1;
bool IsOn(); bool IsOn();
// {
// bool isOn = GetDistance() <= triggerDistance;
// return isOn;
// }
bool isOff(); bool isOff();
// {
// bool isOff = GetDistance() > triggerDistance;
// return isOff;
// }
protected: protected:
float distance = 0; float distance = 0;
}; };