MapPolynomTransformation

MapPolynomTransformation represents a polynom transformation in the configuration api as well as the actual implementation of the transformation in the evaluate method. More...

Inheritance diagram for MapPolynomTransformation:

Public Member Functions
	MapPolynomTransformation (MapConfiguration *config, const std::string &name)
	CTOR. More...
double	getA () const
	Returns parameter A of the polynomial.
double	getB () const
	Returns parameter A of the polynomial.
double	getC () const
	Returns parameter A of the polynomial.
double	getD () const
	Returns parameter A of the polynomial.
double	getE () const
	Returns parameter A of the polynomial.
a_util::result::Result	setCoefficients (const std::string coefs[5])
	Set Polynom coefficients. More...
bool	isEqual (const MapTransformationBase &other) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
double	evaluate (double value) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
MapTransformationBase *	clone () const
	nodoc
Public Member Functions inherited from MapTransformationBase
	MapTransformationBase (MapConfiguration *config, const std::string &name)
	CTOR. More...
virtual	~MapTransformationBase ()
	DTOR.
const std::string &	getName () const
	Returns the name of the transformation.
bool	isValid () const
	Returns the validity for the current description.

Private Member Functions
a_util::result::Result	loadFromDom (const a_util::xml::DOMElement &dom_element)
	Initializes the transformation from a target-dom element. More...
a_util::result::Result	writeToDOM (a_util::xml::DOMElement &dom_element) const
	Export transformation to a XML dom element. More...

Detailed Description

MapPolynomTransformation represents a polynom transformation in the configuration api as well as the actual implementation of the transformation in the evaluate method.

Definition at line 123 of file map_transformation.h.

Constructor & Destructor Documentation

MapPolynomTransformation()

MapPolynomTransformation	(	MapConfiguration *	config,
		const std::string &	name
	)

CTOR.

Parameters

[in]	config	The configuration
[in]	name	The transformation name

Member Function Documentation

loadFromDom()

a_util::result::Result loadFromDom ( const a_util::xml::DOMElement &  dom_element )

private

Initializes the transformation from a target-dom element.

Parameters

[in]

dom_element

The dom element from which to import

Return values

ERR_INVALID_ARG	An attribute is not a float value
a_util::result::SUCCESS	Everything went fine

setCoefficients()

a_util::result::Result setCoefficients

(

const std::string

coefs[5]

)

Set Polynom coefficients.

Parameters

[in]

coefs

The list of coefficients

Return values

ERR_INVALID_ARG	An attribute is not a float value
a_util::result::SUCCESS	Everything went fine

writeToDOM()

a_util::result::Result writeToDOM ( a_util::xml::DOMElement &  dom_element ) const

private

Export transformation to a XML dom element.

Parameters

[in]

dom_element

The dom element to be written

Return values

a_util::result::SUCCESS

Everything went fine