CFunction Class Reference

#include <DianaNLPTask.hpp>

Inheritance diagram for CFunction:

List of all members.

Public Member Functions
	CFunction (evalfunc f)
CapeDouble	Exec (Numeric::Solvers::NLPTasks::ICapeNLPTask &task) throw (Common::Error::ECapeSolvingError)
virtual const Common::Types::CapeString &	GetComponentName () const throw (Common::Error::ECapeUnknown)
virtual void	SetComponentName (const Common::Types::CapeString &_name) throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument)
virtual const Common::Types::CapeString &	GetComponentDescription () const throw (Common::Error::ECapeUnknown)
virtual void	SetComponentDescription (const Common::Types::CapeString &_description) throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument)
virtual ICapeIdentification *	clone () throw (Common::Error::ECapeUnknown, Common::Error::ECapeNoImpl)
	creates clone copy of the interface.
Private Attributes
evalfunc	pCFunc
	pointer on C-function
Common::Types::CapeString	strName
	Component name.
Common::Types::CapeString	strDescription
	Component description.

---

Detailed Description

Class which holds C-function.

---

Constructor & Destructor Documentation

CFunction

(

evalfunc

f

)

Constructor that initializes class and sets specified C function.

---

Member Function Documentation

CapeDouble Exec

(

Numeric::Solvers::NLPTasks::ICapeNLPTask &

task

)

throw (Common::Error::ECapeSolvingError) [inline, virtual]

Executes C function.

Parameters:

task	nlp task containing data(parameters, etc.) for function calculation

Returns:

calculated function value

Implements ICapeNLPFunction.

virtual const Common::Types::CapeString& GetComponentDescription

(

)

const throw (Common::Error::ECapeUnknown) [virtual]

Gets the description of the component.

Reimplemented from ICapeNLPFunction.

virtual const Common::Types::CapeString& GetComponentName

(

)

const throw (Common::Error::ECapeUnknown) [virtual]

Gets the name of the component.

Reimplemented from ICapeNLPFunction.

virtual void SetComponentDescription

(

const Common::Types::CapeString &

_description

)

throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument) [virtual]

Sets the description of the component.

Parameters:

_description

the description of the component

Reimplemented from ICapeNLPFunction.

virtual void SetComponentName

(

const Common::Types::CapeString &

_name

)

throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument) [virtual]

Sets the name of the component.

Parameters:

_name

the name of the component

Reimplemented from ICapeNLPFunction.

---

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

• DianaNLPTask.hpp