Allows to transform the output of the ControlLaw before passing it to the Process. More...

#include <clipping_functionality.hpp>

Inheritance diagram for ClippingFunctionality:

Public Member Functions
	ClippingFunctionality ()
	ClippingFunctionality (uint _nU, uint _nP=0)
	ClippingFunctionality (const ClippingFunctionality &rhs)
ClippingFunctionality &	operator= (const ClippingFunctionality &rhs)
returnValue	setControlLowerLimit (uint idx, double _lowerLimit)
returnValue	setControlLowerLimits (const DVector &_lowerLimit)
returnValue	setControlUpperLimit (uint idx, double _upperLimit)
returnValue	setControlUpperLimits (const DVector &_upperLimit)
returnValue	setParameterLowerLimit (uint idx, double _lowerLimit)
returnValue	setParameterLowerLimits (const DVector &_lowerLimit)
returnValue	setParameterUpperLimit (uint idx, double _upperLimit)
returnValue	setParameterUpperLimits (const DVector &_upperLimit)
	~ClippingFunctionality ()
Protected Member Functions
returnValue	clipSignals (VariablesGrid &_u, VariablesGrid &_p=emptyVariablesGrid)
returnValue	clipSignals (DVector &_u, DVector &_p=emptyVector)
uint	getNumControlLimits () const
uint	getNumParameterLimits () const
Protected Attributes
DVector	lowerLimitControls
DVector	lowerLimitParameters
DVector	upperLimitControls
DVector	upperLimitParameters

Detailed Description

Allows to transform the output of the ControlLaw before passing it to the Process.

The class ClippingFunctionality allows to limit the output of the ControlLaw before passing it as signal to control the Process.

Author:: Hans Joachim Ferreau, Boris Houska

Definition at line 56 of file clipping_functionality.hpp.

Constructor & Destructor Documentation

BEGIN_NAMESPACE_ACADO ClippingFunctionality::ClippingFunctionality ( )

Default constructor.

Definition at line 46 of file clipping_functionality.cpp.

ClippingFunctionality::ClippingFunctionality	(	uint	_nU,
		uint	_nP = `0`
	)

Constructor which takes dimensions of the signals to be clipped.

Parameters:

[in]	_nU	Number of control signals to be clipped.
[in]	_nP	Number of parameter signals to be clipped.

Definition at line 51 of file clipping_functionality.cpp.

ClippingFunctionality::ClippingFunctionality ( const ClippingFunctionality & rhs )

Copy constructor (deep copy).

Parameters:

[in] rhs Right-hand side object.

Definition at line 67 of file clipping_functionality.cpp.

ClippingFunctionality::~ClippingFunctionality ( )

Destructor.

Definition at line 77 of file clipping_functionality.cpp.

Member Function Documentation

returnValue ClippingFunctionality::clipSignals	(	VariablesGrid &	_u,
		VariablesGrid &	_p = `emptyVariablesGrid`
	)		`[protected]`

Actually clips given control and parameter signals.

Parameters:

[in,out]	_u	Control signal sequence to be clipped.
[in,out]	_p	Parameter signal sequence to be clipped.

Returns:: SUCCESSFUL_RETURN,
RET_VECTOR_DIMENSION_MISMATCH

Definition at line 202 of file clipping_functionality.cpp.

returnValue ClippingFunctionality::clipSignals	(	DVector &	_u,
		DVector &	_p = `emptyVector`
	)		`[protected]`

Actually clips given control and parameter signals.

Parameters:

[in,out]	_u	Control signal to be clipped.
[in,out]	_p	Parameter signal to be clipped.

Returns:: SUCCESSFUL_RETURN,
RET_VECTOR_DIMENSION_MISMATCH

Definition at line 245 of file clipping_functionality.cpp.

uint ClippingFunctionality::getNumControlLimits ( ) const [inline, protected]

Returns number of control signal limits.

Returns:: Number of control signal limits

uint ClippingFunctionality::getNumParameterLimits ( ) const [inline, protected]

Returns number of parameter signal limits.

Returns:: Number of parameter signal limits

ClippingFunctionality & ClippingFunctionality::operator= ( const ClippingFunctionality & rhs )

Assignment operator (deep copy).

Parameters:

[in] rhs Right-hand side object.

Definition at line 82 of file clipping_functionality.cpp.

returnValue ClippingFunctionality::setControlLowerLimit	(	uint	idx,
		double	_lowerLimit
	)

Assigns new lower limit on given component of the control signal.

Parameters:

[in]	idx	Index of control signal component.
[in]	_lowerLimit	New lower limit.

Returns:: SUCCESSFUL_RETURN,
RET_INDEX_OUT_OF_BOUNDS

Definition at line 110 of file clipping_functionality.cpp.

returnValue ClippingFunctionality::setControlLowerLimits ( const DVector & _lowerLimit )

Assigns new lower limits on control signals.

Parameters:

[in] _lowerLimit New lower limits on control signals.

Returns:: SUCCESSFUL_RETURN,
RET_VECTOR_DIMENSION_MISMATCH

Definition at line 98 of file clipping_functionality.cpp.

returnValue ClippingFunctionality::setControlUpperLimit	(	uint	idx,
		double	_upperLimit
	)

Assigns new upper limit on given component of the control signal.

Parameters:

[in]	idx	Index of control signal component.
[in]	_upperLimit	New upper limit.

Returns:: SUCCESSFUL_RETURN,
RET_INDEX_OUT_OF_BOUNDS

Definition at line 134 of file clipping_functionality.cpp.

returnValue ClippingFunctionality::setControlUpperLimits ( const DVector & _upperLimit )

Assigns new upper limits on control signals.

Parameters:

[in] _upperLimit New upper limits on control signals.

Returns:: SUCCESSFUL_RETURN,
RET_VECTOR_DIMENSION_MISMATCH

Definition at line 122 of file clipping_functionality.cpp.

returnValue ClippingFunctionality::setParameterLowerLimit	(	uint	idx,
		double	_lowerLimit
	)

Assigns new lower limit on given component of the parameter signal.

Parameters:

[in]	idx	Index of parameter signal component.
[in]	_lowerLimit	New lower limit.

Returns:: SUCCESSFUL_RETURN,
RET_INDEX_OUT_OF_BOUNDS

Definition at line 159 of file clipping_functionality.cpp.

returnValue ClippingFunctionality::setParameterLowerLimits ( const DVector & _lowerLimit )

Assigns new lower limits on parameter signals.

Parameters:

[in] _lowerLimit New lower limits on parameter signals.

Returns:: SUCCESSFUL_RETURN,
RET_VECTOR_DIMENSION_MISMATCH

Definition at line 147 of file clipping_functionality.cpp.

returnValue ClippingFunctionality::setParameterUpperLimit	(	uint	idx,
		double	_upperLimit
	)

Assigns new upper limit on given component of the parameter signal.

Parameters:

[in]	idx	Index of parameter signal component.
[in]	_upperLimit	New upper limit.

Returns:: SUCCESSFUL_RETURN,
RET_INDEX_OUT_OF_BOUNDS

Definition at line 183 of file clipping_functionality.cpp.

returnValue ClippingFunctionality::setParameterUpperLimits ( const DVector & _upperLimit )

Assigns new upper limits on parameter signals.

Parameters:

[in] _upperLimit New upper limits on parameter signals.

Returns:: SUCCESSFUL_RETURN,
RET_VECTOR_DIMENSION_MISMATCH

Definition at line 171 of file clipping_functionality.cpp.

Member Data Documentation

DVector ClippingFunctionality::lowerLimitControls [protected]

Lower limits on control signals.

Definition at line 234 of file clipping_functionality.hpp.

DVector ClippingFunctionality::lowerLimitParameters [protected]

Lower limits on parameter signals.

Definition at line 237 of file clipping_functionality.hpp.

DVector ClippingFunctionality::upperLimitControls [protected]

Upper limits on control signals.

Definition at line 235 of file clipping_functionality.hpp.

DVector ClippingFunctionality::upperLimitParameters [protected]

Upper limits on parameter signals.

Definition at line 238 of file clipping_functionality.hpp.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation