cvr::fixedGridInterpolation< T >::fixedGridInterpolation::parameters Class Reference

The parameters for the class fixedGridInterpolation. More...

#include <cvrFixedGridInterpolation.h>

Inheritance diagram for cvr::fixedGridInterpolation< T >::fixedGridInterpolation::parameters:

[legend]

Collaboration diagram for cvr::fixedGridInterpolation< T >::fixedGridInterpolation::parameters:

[legend]

List of all members.

Public Member Functions
	parameters ()
	parameters (const parameters &other)
	parameters (const eBoundaryType btype)
	~parameters ()
parameters &	copy (const parameters &other)
parameters &	operator= (const parameters &other)
const std::string &	name () const
virtual parameters *	clone () const
virtual parameters *	newInstance () const
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

template<typename T>
class cvr::fixedGridInterpolation< T >::parameters

The parameters for the class fixedGridInterpolation.

---

Constructor & Destructor Documentation

template<typename T>

cvr::fixedGridInterpolation< T >::fixedGridInterpolation::parameters::parameters

(

)

Default constructor.

Reimplemented from cvr::functor::functor::parameters.

Reimplemented in cvr::bilinearInterpolation< T >::bilinearInterpolation::parameters, and cvr::genericInterpolation< T >::genericInterpolation::parameters.

template<typename T>

cvr::fixedGridInterpolation< T >::fixedGridInterpolation::parameters::parameters

(

const parameters &

other

)

Copy constructor.

Parameters:

other

the parameters object to be copied

Reimplemented from cvr::functor::functor::parameters.

Reimplemented in cvr::bilinearInterpolation< T >::bilinearInterpolation::parameters, and cvr::genericInterpolation< T >::genericInterpolation::parameters.

template<typename T>

cvr::fixedGridInterpolation< T >::fixedGridInterpolation::parameters::parameters

(

const eBoundaryType

btype

)

Constructor parameters with given with boundary type.

Reimplemented in cvr::bilinearInterpolation< T >::bilinearInterpolation::parameters, and cvr::genericInterpolation< T >::genericInterpolation::parameters.

template<typename T>

cvr::fixedGridInterpolation< T >::fixedGridInterpolation::parameters::~parameters

(

)

[virtual]

Destructor.

Reimplemented from cvr::functor::functor::parameters.

Reimplemented in cvr::bilinearInterpolation< T >::bilinearInterpolation::parameters, and cvr::genericInterpolation< T >::genericInterpolation::parameters.

---

Member Function Documentation

template<typename T>

virtual parameters* cvr::fixedGridInterpolation< T >::fixedGridInterpolation::parameters::clone

(

)

const [virtual]

Returns a pointer to a clone of the parameters.

Implements cvr::functor::functor::parameters.

Reimplemented in cvr::bilinearInterpolation< T >::bilinearInterpolation::parameters, and cvr::genericInterpolation< T >::genericInterpolation::parameters.

template<typename T>

parameters& cvr::fixedGridInterpolation< T >::fixedGridInterpolation::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 cvr::bilinearInterpolation< T >::bilinearInterpolation::parameters, and cvr::genericInterpolation< T >::genericInterpolation::parameters.

template<typename T>

const std::string& cvr::fixedGridInterpolation< T >::fixedGridInterpolation::parameters::name

(

)

const [virtual]

Returns the name of this class.

Implements cvr::functor::functor::parameters.

Reimplemented in cvr::bilinearInterpolation< T >::bilinearInterpolation::parameters, and cvr::genericInterpolation< T >::genericInterpolation::parameters.

template<typename T>

virtual parameters* cvr::fixedGridInterpolation< T >::fixedGridInterpolation::parameters::newInstance

(

)

const [virtual]

Returns a pointer to a new instance of the parameters.

Implements cvr::functor::functor::parameters.

Reimplemented in cvr::bilinearInterpolation< T >::bilinearInterpolation::parameters, and cvr::genericInterpolation< T >::genericInterpolation::parameters.

template<typename T>

parameters& cvr::fixedGridInterpolation< T >::fixedGridInterpolation::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 cvr::bilinearInterpolation< T >::bilinearInterpolation::parameters, and cvr::genericInterpolation< T >::genericInterpolation::parameters.

template<typename T>

virtual bool cvr::fixedGridInterpolation< T >::fixedGridInterpolation::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 cvr::parametersManager::parametersManager::parameters.

Reimplemented in cvr::bilinearInterpolation< T >::bilinearInterpolation::parameters, and cvr::genericInterpolation< T >::genericInterpolation::parameters.

template<typename T>

virtual bool cvr::fixedGridInterpolation< T >::fixedGridInterpolation::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 cvr::parametersManager::parametersManager::parameters.

Reimplemented in cvr::bilinearInterpolation< T >::bilinearInterpolation::parameters, and cvr::genericInterpolation< T >::genericInterpolation::parameters.

---

Member Data Documentation

template<typename T>

eBoundaryType cvr::fixedGridInterpolation< T >::fixedGridInterpolation::parameters::boundaryType

Specify how the boundaries will be used.

See the documentation for cvr::eBoundaryType for more information

Default: cvr::Zero

---

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

• cvrFixedGridInterpolation.h