An interface that describes a general sensor You can read a value/structure. More...
#include <SensorInterface.hpp>
Public Types | |
| typedef SensorData | DataType |
Public Member Functions | |
| virtual DataType | maxMeasurement () const =0 |
| virtual DataType | minMeasurement () const =0 |
| virtual int | readSensor (DataType &p) const =0 |
| virtual DataType | readSensor () const =0 |
| virtual DataType | zeroMeasurement () const =0 |
| virtual | ~SensorInterface () |
Detailed Description
template<class SensorData>
class RTT::dev::SensorInterface< SensorData >
An interface that describes a general sensor You can read a value/structure.
The OutputData is the actual SI unit of the measured data (e.g. force, velocity,...) and is in case of a 1D sensor a double.
If the sensor is not calibrated, the minMeasurement() and maxMeasurement() functions should return std::numeric_limits<SensorData>::min() and std::numeric_limits<SensorData>::max() respectively.
- See also:
- CalibrationInterface
Definition at line 66 of file SensorInterface.hpp.
Member Typedef Documentation
| typedef SensorData RTT::dev::SensorInterface< SensorData >::DataType |
Definition at line 73 of file SensorInterface.hpp.
Constructor & Destructor Documentation
| virtual RTT::dev::SensorInterface< SensorData >::~SensorInterface | ( | ) | [inline, virtual] |
Definition at line 70 of file SensorInterface.hpp.
Member Function Documentation
| virtual DataType RTT::dev::SensorInterface< SensorData >::maxMeasurement | ( | ) | const [pure virtual] |
Returns the maximum value this sensor can read.
| virtual DataType RTT::dev::SensorInterface< SensorData >::minMeasurement | ( | ) | const [pure virtual] |
Returns the minimum value this sensor can read.
| virtual int RTT::dev::SensorInterface< SensorData >::readSensor | ( | DataType & | p | ) | const [pure virtual] |
Read the Data, the structure that this sensor 'exports'
- Returns:
- 0 on success
- -1 on failure
| virtual DataType RTT::dev::SensorInterface< SensorData >::readSensor | ( | ) | const [pure virtual] |
Return the last measurement.
| virtual DataType RTT::dev::SensorInterface< SensorData >::zeroMeasurement | ( | ) | const [pure virtual] |
Returns the value which would be given with the sensor in ideal rest.
The documentation for this class was generated from the following file: