CalibrateResult Class Reference

CalibrateResult indicates if the calibration is successful or not. More...

#include <calibrator.h>

Public Types
enum	Result { SUCCESS, WARNING, FAILURE }

Public Member Functions
	CalibrateResult (Result result)
	CalibrateResult (Result result, string message)
Result	getResult () const
string	getResultString () const
string	getMessage () const

Detailed Description

CalibrateResult indicates if the calibration is successful or not.

There are three supported result: SUCCESS, WARNING, FAILURE. An optional string description can be supplied to better assist user figuring out why the calibration fails. This class is used as the return value for calibrate function used by CalibrateProcess.

Examples:

user_accelerometer_gestures.cpp, user_accelerometer_poses.cpp, user_accelerometer_walk_detection.cpp, and user_sudden_motion.cpp.

Member Enumeration Documentation

enum CalibrateResult::Result

Enumerator
SUCCESS
WARNING
FAILURE

Constructor & Destructor Documentation

CalibrateResult::CalibrateResult

(

Result

result

)

CalibrateResult::CalibrateResult	(	Result	result,
		string	message
	)

Member Function Documentation

string CalibrateResult::getMessage ( ) const

inline

Result CalibrateResult::getResult ( ) const

inline

string CalibrateResult::getResultString ( ) const

inline

---

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

• src/calibrator.h
• src/calibrator.cpp