lti::interpolator::parameters Class Reference

the parameters for the class interpolator More...

#include <ltiInterpolator.h>

Inheritance diagram for lti::interpolator::parameters:

[legend]

Collaboration diagram for lti::interpolator::parameters:

[legend]

List of all members.

Public Member Functions
	parameters ()
	parameters (const eBoundaryType btype)
	parameters (const parameters &other)
	~parameters ()
const char *	getTypeName () const
parameters &	copy (const parameters &other)
parameters &	operator= (const parameters &other)
virtual functor::parameters *	clone () const =0
virtual bool	write (ioHandler &handler, const bool complete=true) const
virtual bool	read (ioHandler &handler, const bool complete=true)
Public Attributes
eBoundaryType	boundaryType

---

Detailed Description

the parameters for the class interpolator

---

Constructor & Destructor Documentation

lti::interpolator::parameters::parameters

(

)

default constructor

Reimplemented from lti::functor::parameters.

Reimplemented in lti::genericInterpolator< T >::parameters, lti::cubicSpline< T >::parameters, lti::equallySpacedSamplesInterpolator::parameters, lti::scalarValuedInterpolation< T >::parameters, and lti::variablySpacedSamplesInterpolator::parameters.

lti::interpolator::parameters::parameters

(

const eBoundaryType

btype

)

create parameters with the given boundary type

Reimplemented in lti::genericInterpolator< T >::parameters, lti::equallySpacedSamplesInterpolator::parameters, and lti::scalarValuedInterpolation< T >::parameters.

lti::interpolator::parameters::parameters

(

const parameters &

other

)

copy constructor

Parameters:

other

the parameters object to be copied

Reimplemented in lti::genericInterpolator< T >::parameters, lti::cubicSpline< T >::parameters, lti::equallySpacedSamplesInterpolator::parameters, lti::scalarValuedInterpolation< T >::parameters, and lti::variablySpacedSamplesInterpolator::parameters.

lti::interpolator::parameters::~parameters

(

)

[virtual]

destructor

Reimplemented from lti::functor::parameters.

Reimplemented in lti::genericInterpolator< T >::parameters, lti::cubicSpline< T >::parameters, lti::equallySpacedSamplesInterpolator::parameters, lti::scalarValuedInterpolation< T >::parameters, and lti::variablySpacedSamplesInterpolator::parameters.

---

Member Function Documentation

virtual functor::parameters* lti::interpolator::parameters::clone

(

)

const [pure virtual]

returns a pointer to a clone of the parameters

Implements lti::functor::parameters.

Implemented in lti::genericInterpolator< T >::parameters, lti::cubicSpline< T >::parameters, lti::equallySpacedSamplesInterpolator::parameters, lti::scalarValuedInterpolation< T >::parameters, and lti::variablySpacedSamplesInterpolator::parameters.

parameters& lti::interpolator::parameters::copy

(

const parameters &

other

)

copy the contents of a parameters object

Parameters:

other

the parameters object to be copied

Returns:

a reference to this parameters object

Reimplemented in lti::genericInterpolator< T >::parameters, lti::cubicSpline< T >::parameters, lti::equallySpacedSamplesInterpolator::parameters, lti::scalarValuedInterpolation< T >::parameters, and lti::variablySpacedSamplesInterpolator::parameters.

const char* lti::interpolator::parameters::getTypeName

(

)

const [virtual]

returns name of this type

Reimplemented from lti::functor::parameters.

Reimplemented in lti::genericInterpolator< T >::parameters, lti::cubicSpline< T >::parameters, lti::equallySpacedSamplesInterpolator::parameters, lti::scalarValuedInterpolation< T >::parameters, and lti::variablySpacedSamplesInterpolator::parameters.

parameters& lti::interpolator::parameters::operator=

(

const parameters &

other

)

copy the contents of a parameters object

Parameters:

other

the parameters object to be copied

Returns:

a reference to this parameters object

Reimplemented in lti::genericInterpolator< T >::parameters, lti::cubicSpline< T >::parameters, lti::equallySpacedSamplesInterpolator::parameters, lti::scalarValuedInterpolation< T >::parameters, and lti::variablySpacedSamplesInterpolator::parameters.

virtual bool lti::interpolator::parameters::read	(	ioHandler &	handler,
		const bool	complete = true
	)			[virtual]

read the parameters from the given ioHandler

Parameters:

	handler	the ioHandler to be used
	complete	if true (the default) the enclosing begin/end will be also written, otherwise only the data block will be written.

Returns:

true if write was successful

Reimplemented from lti::functor::parameters.

Reimplemented in lti::genericInterpolator< T >::parameters, lti::cubicSpline< T >::parameters, lti::equallySpacedSamplesInterpolator::parameters, lti::scalarValuedInterpolation< T >::parameters, and lti::variablySpacedSamplesInterpolator::parameters.

virtual bool lti::interpolator::parameters::write	(	ioHandler &	handler,
		const bool	complete = true
	)			const [virtual]

write the parameters in the given ioHandler

Parameters:

	handler	the ioHandler to be used
	complete	if true (the default) the enclosing begin/end will be also written, otherwise only the data block will be written.

Returns:

true if write was successful

Reimplemented from lti::functor::parameters.

Reimplemented in lti::genericInterpolator< T >::parameters, lti::cubicSpline< T >::parameters, lti::equallySpacedSamplesInterpolator::parameters, lti::scalarValuedInterpolation< T >::parameters, and lti::variablySpacedSamplesInterpolator::parameters.

---

Member Data Documentation

eBoundaryType lti::interpolator::parameters::boundaryType

Specify how the boundaries will be used.

See the documentation for lti::eBoundaryType for more information

Referenced by lti::genericInterpolator< T >::parameters::parameters().

---

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

• ltiInterpolator.h