A data sample to be collected by the user and callback for processing that sample. More...

#include <calibrator.h>

Public Types
typedef CalibrateResult(*	CalibratorCallback) (const GRT::MatrixDouble &)

Public Member Functions
	CalibrateProcess (std::string name, std::string description, CalibratorCallback cb)

CalibrateResult	calibrate (GRT::MatrixDouble data)

void	clear ()

bool	isCalibrated () const

std::string	getName () const

std::string	getDescription () const

void	setData (GRT::MatrixDouble data)

GRT::MatrixDouble	getData ()

Detailed Description

A data sample to be collected by the user and callback for processing that sample.

A CalibrateProcess stores the name and description of a sample of sensor data to be collected by the user, along with a callback for processing that sample once it's collected. To use a CalibrateProcess instance, add it to a Calibrator with Calibrator::addCalibrateProcess().

Member Typedef Documentation

typedef CalibrateResult(* CalibrateProcess::CalibratorCallback) (const GRT::MatrixDouble &)

CalibrateProcess::CalibrateProcess	(	std::string	name,
		std::string	description,
		CalibratorCallback	cb
	)

inline

Parameters

name	the name of the calibration sample to be collected by the user
description	the description of the calibration sample to be collected by the user
cb	the callback to call with the data collected by the user (as a MatrixDouble &). Called each time the user collects or re-collects the associated calibration sample.

CalibrateResult CalibrateProcess::calibrate ( GRT::MatrixDouble data )

inline

void CalibrateProcess::clear ( )

inline

GRT::MatrixDouble CalibrateProcess::getData ( )

inline

std::string CalibrateProcess::getDescription ( ) const

inline

std::string CalibrateProcess::getName ( ) const

inline

bool CalibrateProcess::isCalibrated ( ) const

inline

void CalibrateProcess::setData ( GRT::MatrixDouble data )

inline

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