OutputFcn Class Reference

Allows to setup and evaluate output functions based on SymbolicExpressions. More...

#include <output_fcn.hpp>

Inheritance diagram for OutputFcn:

List of all members.

Public Member Functions
returnValue	evaluate (double *x, double *_result)
returnValue	evaluate (const VariablesGrid *x, const VariablesGrid *xa, const VariablesGrid *p, const VariablesGrid *u, const VariablesGrid *w, VariablesGrid *_result)
DVector	evaluate (const EvaluationPoint &x, const int &number=0)
BooleanType	isDefined () const
Output	operator() (uint componentIdx)
OutputFcn &	operator= (const OutputFcn &rhs)
	OutputFcn ()
	OutputFcn (const OutputFcn &rhs)
virtual	~OutputFcn ()

---

Detailed Description

Allows to setup and evaluate output functions based on SymbolicExpressions.

The class OutputFcn allows to setup and evaluate output functions based on SymbolicExpressions.

Author:

Boris Houska, Hans Joachim Ferreau

Definition at line 55 of file output_fcn.hpp.

---

Constructor & Destructor Documentation

BEGIN_NAMESPACE_ACADO OutputFcn::OutputFcn

(

)

Default constructor.

Definition at line 48 of file output_fcn.cpp.

OutputFcn::OutputFcn

(

const OutputFcn &

rhs

)

Copy constructor (deep copy).

Definition at line 53 of file output_fcn.cpp.

OutputFcn::~OutputFcn

(

)

[virtual]

Destructor.

Definition at line 58 of file output_fcn.cpp.

---

Member Function Documentation

returnValue OutputFcn::evaluate	(	double *	x,
		double *	_result
	)

Evaluates the function

Returns:

SUCCESSFUL_RETURN
RET_NAN

Parameters:

x	the input variable x
_result	the result

Definition at line 91 of file output_fcn.cpp.

returnValue OutputFcn::evaluate	(	const VariablesGrid *	x,
		const VariablesGrid *	xa,
		const VariablesGrid *	p,
		const VariablesGrid *	u,
		const VariablesGrid *	w,
		VariablesGrid *	_result
	)

Evaluates the output function on a variables grid

Returns:

SUCCESSFUL_RETURN

Definition at line 98 of file output_fcn.cpp.

DVector OutputFcn::evaluate	(	const EvaluationPoint &	x,
		const int &	number = 0
	)

Evaluates the function.

Parameters:

x	the evaluation point
number	the storage position

Returns:

The result of the evaluation.

Reimplemented from Function.

Definition at line 124 of file output_fcn.cpp.

BooleanType OutputFcn::isDefined

(

)

const [inline]

Output OutputFcn::operator()

(

uint

componentIdx

)

Definition at line 74 of file output_fcn.cpp.

OutputFcn & OutputFcn::operator=

(

const OutputFcn &

rhs

)

Assignment operator (deep copy).

Definition at line 63 of file output_fcn.cpp.

---

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

• output_fcn.hpp
• output_fcn.cpp