lti::functionGenerator::parameters Class Reference

The parameters for the class functionGenerator. More...

#include <ltiFunctionGenerator.h>

Inheritance diagram for lti::functionGenerator::parameters:

[legend]

Collaboration diagram for lti::functionGenerator::parameters:

[legend]

List of all members.

Public Member Functions
	parameters ()
	parameters (const parameters &other)
	~parameters ()
const char *	getTypeName () const
parameters &	copy (const parameters &other)
parameters &	operator= (const parameters &other)
virtual functor::parameters *	clone () const
virtual bool	write (ioHandler &handler, const bool complete=true) const
virtual bool	read (ioHandler &handler, const bool complete=true)
Public Attributes
std::string	function
std::string	nameVarX
std::string	nameVarY

---

Detailed Description

The parameters for the class functionGenerator.

---

Constructor & Destructor Documentation

lti::functionGenerator::parameters::parameters

(

)

Default constructor.

Reimplemented from lti::mathFunction::parameters.

lti::functionGenerator::parameters::parameters

(

const parameters &

other

)

Copy constructor.

Parameters:

other

the parameters object to be copied

Reimplemented from lti::mathFunction::parameters.

lti::functionGenerator::parameters::~parameters

(

)

[virtual]

Destructor.

Reimplemented from lti::mathFunction::parameters.

---

Member Function Documentation

virtual functor::parameters* lti::functionGenerator::parameters::clone

(

)

const [virtual]

Returns a pointer to a clone of the parameters.

Reimplemented from lti::mathFunction::parameters.

parameters& lti::functionGenerator::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 from lti::mathFunction::parameters.

const char* lti::functionGenerator::parameters::getTypeName

(

)

const [virtual]

Returns name of this type.

Reimplemented from lti::mathFunction::parameters.

parameters& lti::functionGenerator::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 from lti::mathFunction::parameters.

virtual bool lti::functionGenerator::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::mathFunction::parameters.

virtual bool lti::functionGenerator::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::mathFunction::parameters.

---

Member Data Documentation

std::string lti::functionGenerator::parameters::function

string containing the function to evaluate

std::string lti::functionGenerator::parameters::nameVarX

Name of the first argument.

Default is 'x'. Do not change if it is not necessary. If a name is chosen which is already reserved for function names, operators,or literals the behaviour is unpredictable.

std::string lti::functionGenerator::parameters::nameVarY

Name of the second argument.

Default is 'y'. Do not change if it is not necessary. If a name is chosen which is already reserved for function names, operators,or literals the behaviour is unpredictable.

---

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

• ltiFunctionGenerator.h