trek::Calibrator Class Reference

This class is the abstraction for all numeric calibration. More...

#include <calibrator.h>

Inherits trek::NamedItem.

Inherited by trek::PolynomialCalibrator, and trek::SplineCalibrator.

Public Member Functions
virtual int32_t	Calibrate (double input_value, double &output_value)=0
	Virtual method for derived classes to calibrate an input value. More...
Constructors, Destructor, and Other Basic Methods
	Calibrator ()
	Default constructor of the class.
	Calibrator (Calibrator &input)
	Copy constructor of the class.
virtual	~Calibrator ()
	Class destructor. More...
void	operator= (Calibrator &right_side)
	Provides the equal operator.
virtual void	Init ()
	Initializes the object.
Public Member Functions inherited from trek::NamedItem
void	SetName (const char *input_ptr)
	Sets the name of the item. More...
void	SetAlias (const char *input)
	Sets the alias of the item. More...
void	SetShortDescription (const char *input_ptr)
	Sets the short description of the item. More...
void	SetLongDescription (const char *input_ptr)
	Sets the long description of the item. More...
void	SetUserDescription (const char *input_ptr)
	Sets the user description of the item. More...
void	SetOwner (const char *input_ptr)
	Sets the owner of the item. More...
const char *	GetName ()
	Returns the name of the item.
const char *	GetAlias ()
	Returns the alias of the item.
const char *	GetShortDescription ()
	Returns the short description of the item.
const char *	GetLongDescription ()
	Returns the long description of the item.
const char *	GetUserDescription ()
	Returns the user description of the item.
const char *	GetOwner ()
	Returns the owner of the item.
	NamedItem ()
	Default constructor of the class.
	NamedItem (NamedItem &input)
	Copy constructor of the class.
virtual	~NamedItem ()
	Class destructor. More...
void	operator= (NamedItem &right_side)
	Provides the equal operator.
bool	operator== (NamedItem &right_side)
	Provides the == operator.

Detailed Description

This class is the abstraction for all numeric calibration.

Calibration is supported for values that can be stored as a double precision floating point.

Examples:

integrate_user_calibrator/integrate_user_calibrator.cpp.

Constructor & Destructor Documentation

~Calibrator()

trek::Calibrator::~Calibrator ( )

virtual

Class destructor.

Removes all resources created with this instance of the class.

Member Function Documentation

Calibrate()

virtual int32_t trek::Calibrator::Calibrate ( double  input_value, double &  output_value  )

pure virtual

Virtual method for derived classes to calibrate an input value.

Parameters

[in]	input_value	Value to calibrate.
[out]	output_value	Calibrated value.

Returns

SUCCESS - output_value holds calibrated value other -defined by derived classes

Implemented in trek::PolynomialCalibrator, and trek::SplineCalibrator.