mirror of
https://github.com/eclipse/upm.git
synced 2025-03-14 20:47:30 +03:00
Update interface documentation
Signed-off-by: Serban Waltter <serban.waltter@rinftech.com>
This commit is contained in:
parent
2acecb1e62
commit
d3ff8cfbc7
@ -40,7 +40,7 @@ namespace upm
|
||||
/**
|
||||
* Get distance from sensor
|
||||
*
|
||||
* @return Returns the distance
|
||||
* @return Returns the distance in cm
|
||||
*/
|
||||
virtual float getDistance() = 0;
|
||||
/**
|
||||
|
@ -33,6 +33,12 @@ namespace upm
|
||||
{
|
||||
public:
|
||||
virtual ~iDistanceInterrupter() {}
|
||||
|
||||
/**
|
||||
* Determines if objected is detected
|
||||
*
|
||||
* @return True if the sensor has detected an object
|
||||
*/
|
||||
virtual bool objectDetected() = 0;
|
||||
};
|
||||
}
|
||||
|
@ -37,7 +37,7 @@ namespace upm
|
||||
/**
|
||||
* Retrieve the computed heart rate
|
||||
*
|
||||
* @return Computed heart rate
|
||||
* @return Computed heart rate in BPM (beats per minute)
|
||||
*/
|
||||
virtual int getHeartRate() = 0;
|
||||
};
|
||||
|
@ -37,7 +37,7 @@ namespace upm
|
||||
/**
|
||||
* Measures humidity around the sensor
|
||||
*
|
||||
* @return Gets the humidity value
|
||||
* @return Gets the relativ humidity value (%)
|
||||
*/
|
||||
virtual float getHumidity() = 0;
|
||||
};
|
||||
|
@ -37,7 +37,7 @@ namespace upm
|
||||
/**
|
||||
* Get luminance
|
||||
*
|
||||
* @return Luminance value
|
||||
* @return Luminance value in lux
|
||||
*/
|
||||
virtual float getLuminance() = 0;
|
||||
};
|
||||
|
@ -42,7 +42,7 @@ namespace upm
|
||||
/**
|
||||
* Measures temperature
|
||||
*
|
||||
* @return temperature value
|
||||
* @return temperature value in degrees Celsius
|
||||
*/
|
||||
virtual float getTemperature() = 0;
|
||||
|
||||
|
@ -92,9 +92,9 @@ namespace upm {
|
||||
int inches();
|
||||
|
||||
/**
|
||||
* Gets the distance to the object in inches
|
||||
* Gets the distance to the object in cm
|
||||
*
|
||||
* @return Distance to the object in inches
|
||||
* @return Distance to the object in cm
|
||||
*/
|
||||
virtual float getDistance();
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user