Public Member Functions | Protected Attributes
RTT::dev::CalibrationInterface Class Reference

A class which will calibrate a sensor. It is useful for making 'calibration' objects. More...

#include <CalibrationInterface.hpp>

Inheritance diagram for RTT::dev::CalibrationInterface:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual void calibrate ()
 Start or perform calibration.
 CalibrationInterface ()
virtual bool isCalibrated () const
 Inspect if a calibration has been done.
virtual void unCalibrate ()
 Undo any previous calibration ( this function may have no effect ).
virtual ~CalibrationInterface ()

Protected Attributes

bool calibrated

Detailed Description

A class which will calibrate a sensor. It is useful for making 'calibration' objects.

See also:
SensorInterface

Definition at line 52 of file CalibrationInterface.hpp.


Constructor & Destructor Documentation

Definition at line 57 of file CalibrationInterface.hpp.

Definition at line 58 of file CalibrationInterface.hpp.


Member Function Documentation

virtual void RTT::dev::CalibrationInterface::calibrate ( ) [inline, virtual]

Start or perform calibration.

Definition at line 62 of file CalibrationInterface.hpp.

virtual bool RTT::dev::CalibrationInterface::isCalibrated ( ) const [inline, virtual]

Inspect if a calibration has been done.

Returns:
True if so.

Definition at line 70 of file CalibrationInterface.hpp.

virtual void RTT::dev::CalibrationInterface::unCalibrate ( ) [inline, virtual]

Undo any previous calibration ( this function may have no effect ).

Definition at line 76 of file CalibrationInterface.hpp.


Member Data Documentation

Definition at line 55 of file CalibrationInterface.hpp.


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


rtt
Author(s): RTT Developers
autogenerated on Thu Jan 2 2014 11:35:43