SensorInterface Class Template Reference
[Device Interfaces]

#include </home/sspr/src/www/orocos-1.0/export/build/orocos-rtt-1.2.2/build/rtt/dev/SensorInterface.hpp>

Inheritance diagram for SensorInterface:

List of all members.

---

Detailed Description

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

Public Types
typedef SensorData	DataType
Public Member Functions
virtual int	readSensor (DataType &p) const =0
	Read the Data, the structure that this sensor 'exports'.
virtual DataType	readSensor () const=0
	Return the last measurement.
virtual DataType	maxMeasurement () const=0
	Returns the maximum value this sensor can read.
virtual DataType	minMeasurement () const=0
	Returns the minimum value this sensor can read.
virtual DataType	zeroMeasurement () const=0
	Returns the value which would be given with the sensor in ideal rest.
virtual void	calibrate ()
	Start or perform calibration.
virtual bool	isCalibrated () const
	Inspect if a calibration has been done.
virtual void	unCalibrate ()
	Undo any previous calibration ( this function may have no effect ).
Protected Attributes
bool	calibrated

---

Member Function Documentation

virtual int readSensor

(

DataType &

p

)

const [pure virtual]

Read the Data, the structure that this sensor 'exports'.

Returns:

0 on success

-1 on failure

virtual bool isCalibrated

(

)

const [inline, virtual, inherited]

Inspect if a calibration has been done.

Returns:

True if so.

---

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

• rtt/dev/SensorInterface.hpp

---