Public Types | Public Member Functions | List of all members
RTT::dev::SensorInterface< SensorData > Class Template Referenceabstract

An interface that describes a general sensor You can read a value/structure. More...

#include <rtt-dev-fwd.hpp>

Inheritance diagram for RTT::dev::SensorInterface< SensorData >:
Inheritance graph
[legend]

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 ()
 
- Public Member Functions inherited from RTT::dev::CalibrationInterface
virtual void calibrate ()
 Start or perform calibration. More...
 
 CalibrationInterface ()
 
virtual bool isCalibrated () const
 Inspect if a calibration has been done. More...
 
virtual void unCalibrate ()
 Undo any previous calibration ( this function may have no effect ). More...
 
virtual ~CalibrationInterface ()
 

Additional Inherited Members

- Protected Attributes inherited from RTT::dev::CalibrationInterface
bool calibrated
 

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 61 of file rtt-dev-fwd.hpp.

Member Typedef Documentation

template<class SensorData >
typedef SensorData RTT::dev::SensorInterface< SensorData >::DataType

Definition at line 73 of file SensorInterface.hpp.

Constructor & Destructor Documentation

template<class SensorData >
virtual RTT::dev::SensorInterface< SensorData >::~SensorInterface ( )
inlinevirtual

Definition at line 70 of file SensorInterface.hpp.

Member Function Documentation

template<class SensorData >
virtual DataType RTT::dev::SensorInterface< SensorData >::maxMeasurement ( ) const
pure virtual

Returns the maximum value this sensor can read.

template<class SensorData >
virtual DataType RTT::dev::SensorInterface< SensorData >::minMeasurement ( ) const
pure virtual

Returns the minimum value this sensor can read.

template<class SensorData >
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
template<class SensorData >
virtual DataType RTT::dev::SensorInterface< SensorData >::readSensor ( ) const
pure virtual

Return the last measurement.

template<class SensorData >
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 files:


rtt
Author(s): RTT Developers
autogenerated on Tue Jun 25 2019 19:33:43