Public Member Functions | Protected Attributes | List of all members
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]

Public Member Functions

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 ()
 

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

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

Definition at line 57 of file CalibrationInterface.hpp.

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

Definition at line 58 of file CalibrationInterface.hpp.

Member Function Documentation

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

Start or perform calibration.

Definition at line 62 of file CalibrationInterface.hpp.

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

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 ( )
inlinevirtual

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
protected

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 Fri Oct 25 2019 03:59:46