RTT::dev::CalibrationInterface Class Reference
[Device Interfaces]

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.
virtual void calibrate ()
 Start or perform calibration.
 CalibrationInterface ()
 CalibrationInterface ()
virtual bool isCalibrated () const
 Inspect if a calibration has been done.
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 void unCalibrate ()
 Undo any previous calibration ( this function may have no effect ).
virtual ~CalibrationInterface ()
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 install/include/rtt/extras/dev/CalibrationInterface.hpp.


Constructor & Destructor Documentation

RTT::dev::CalibrationInterface::CalibrationInterface (  )  [inline]
virtual RTT::dev::CalibrationInterface::~CalibrationInterface (  )  [inline, virtual]
RTT::dev::CalibrationInterface::CalibrationInterface (  )  [inline]

Definition at line 57 of file rtt/extras/dev/CalibrationInterface.hpp.

virtual RTT::dev::CalibrationInterface::~CalibrationInterface (  )  [inline, virtual]

Definition at line 58 of file rtt/extras/dev/CalibrationInterface.hpp.


Member Function Documentation

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

Start or perform calibration.

Definition at line 62 of file rtt/extras/dev/CalibrationInterface.hpp.

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

Start or perform calibration.

Definition at line 62 of file install/include/rtt/extras/dev/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 rtt/extras/dev/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 install/include/rtt/extras/dev/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 rtt/extras/dev/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 install/include/rtt/extras/dev/CalibrationInterface.hpp.


Member Data Documentation


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


rtt
Author(s): RTT Developers
autogenerated on Fri Jan 11 09:49:55 2013