onboardsdk
Loading...
Searching...
No Matches
Public Member Functions | List of all members
blunux::observer::ICompassCalibration Class Referenceabstract

Public Member Functions

virtual void startCalibration ()=0
 Start the compass calibration.
 
virtual void cancelCalibration ()=0
 Cancel the compass calibration.
 
virtual bool finishCalibration ()=0
 Finish the compass calibration.
 
virtual CompassCalibrationProgress getCalibrationProgress () const =0
 Get the compass calibration status and progress of all axis.
 
virtual bool isCalibrating () const =0
 Check if the compass calibration is in progress.
 
virtual bool isCalibrationFinished () const =0
 Check if the compass calibration is done.
 
virtual bool isReadyForThrusterCalibration () const =0
 Check if the calibrator is ready for thruster calibration.
 

Member Function Documentation

◆ finishCalibration()

virtual bool blunux::observer::ICompassCalibration::finishCalibration ( )
pure virtual

Finish the compass calibration.

Returns
true The calibration finished corectly
false The calibration is not complete or not active

◆ getCalibrationProgress()

virtual CompassCalibrationProgress blunux::observer::ICompassCalibration::getCalibrationProgress ( ) const
pure virtual

Get the compass calibration status and progress of all axis.

Returns
CompassCalibrationProgress Structure containing the progress

◆ isCalibrating()

virtual bool blunux::observer::ICompassCalibration::isCalibrating ( ) const
pure virtual

Check if the compass calibration is in progress.

Returns
true The calibration is in progress
false The calibration is not in progress (finished or not started)

◆ isCalibrationFinished()

virtual bool blunux::observer::ICompassCalibration::isCalibrationFinished ( ) const
pure virtual

Check if the compass calibration is done.

Returns
bool true if the calibration is done

◆ isReadyForThrusterCalibration()

virtual bool blunux::observer::ICompassCalibration::isReadyForThrusterCalibration ( ) const
pure virtual

Check if the calibrator is ready for thruster calibration.

Returns
bool true if the calibrator is ready for thruster calibration

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