Orocos Real-Time Toolkit  2.9.0
Public Member Functions | Protected Attributes | List of all members
RTT::dev::CalibrationInterface Class Reference

A class which will calibrate a sensor. More...

#include <rtt/extras/dev/CalibrationInterface.hpp>

Inheritance diagram for RTT::dev::CalibrationInterface:
RTT::dev::SensorInterface< SensorData >

Public Member Functions

 CalibrationInterface ()
virtual ~CalibrationInterface ()
virtual void calibrate ()
 Start or perform calibration. More...
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...

Protected Attributes

bool calibrated

Detailed Description

A class which will calibrate a sensor.

It is useful for making 'calibration' objects.

See also

Definition at line 52 of file CalibrationInterface.hpp.

Constructor & Destructor Documentation

RTT::dev::CalibrationInterface::CalibrationInterface ( )

Definition at line 57 of file CalibrationInterface.hpp.

virtual RTT::dev::CalibrationInterface::~CalibrationInterface ( )

Definition at line 58 of file CalibrationInterface.hpp.

Member Function Documentation

virtual void RTT::dev::CalibrationInterface::calibrate ( )

Start or perform calibration.

Definition at line 62 of file CalibrationInterface.hpp.

virtual bool RTT::dev::CalibrationInterface::isCalibrated ( ) const

Inspect if a calibration has been done.

True if so.

Definition at line 70 of file CalibrationInterface.hpp.

virtual void RTT::dev::CalibrationInterface::unCalibrate ( )

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

Definition at line 76 of file CalibrationInterface.hpp.

Member Data Documentation

bool RTT::dev::CalibrationInterface::calibrated

Definition at line 55 of file CalibrationInterface.hpp.

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