Public Member Functions | Protected Attributes

Allows to export automatically generated algorithms for fast model predictive control. More...

#include <export_algorithm.hpp>

Inheritance diagram for ExportAlgorithm:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 ExportAlgorithm (UserInteraction *_userInteraction=0, const std::string &_commonHeaderName=std::string())
virtual returnValue getCode (ExportStatementBlock &code)=0
virtual returnValue getDataDeclarations (ExportStatementBlock &declarations, ExportStruct dataStruct=ACADO_ANY) const =0
virtual returnValue getFunctionDeclarations (ExportStatementBlock &declarations) const =0
uint getN () const
uint getNDX () const
uint getNOD () const
uint getNP () const
uint getNU () const
uint getNX () const
uint getNXA () const
uint getNY () const
uint getNYN () const
returnValue setDimensions (uint _NX=0, uint _NU=0, uint _NP=0, uint _NI=0, uint _NOD=0)
returnValue setDimensions (uint _NX, uint _NDX, uint _NXA, uint _NU, uint _NP, uint _NI, uint _NOD)
void setNY (uint NY_)
void setNYN (uint NYN_)
virtual returnValue setup ()
virtual ~ExportAlgorithm ()

Protected Attributes

std::string commonHeaderName
uint N
uint NDX
uint NOD
uint NP
uint NU
uint NX
uint NXA
uint NY
uint NYN

Detailed Description

Allows to export automatically generated algorithms for fast model predictive control.

The class ExportAlgorithm allows to export automatically generated algorithms for fast model predictive control.

Author:
Hans Joachim Ferreau, Milan Vukov, Boris Houska

Definition at line 61 of file export_algorithm.hpp.


Constructor & Destructor Documentation

BEGIN_NAMESPACE_ACADO ExportAlgorithm::ExportAlgorithm ( UserInteraction _userInteraction = 0,
const std::string &  _commonHeaderName = std::string() 
)

Default constructor.

Parameters:
[in]_userInteractionPointer to corresponding user interface.
[in]_commonHeaderNameName of common header file to be included.

Definition at line 45 of file export_algorithm.cpp.

Destructor.

Definition at line 54 of file export_algorithm.cpp.


Member Function Documentation

virtual returnValue ExportAlgorithm::getCode ( ExportStatementBlock code) [pure virtual]
virtual returnValue ExportAlgorithm::getDataDeclarations ( ExportStatementBlock declarations,
ExportStruct  dataStruct = ACADO_ANY 
) const [pure virtual]
virtual returnValue ExportAlgorithm::getFunctionDeclarations ( ExportStatementBlock declarations) const [pure virtual]

Returns number of control intervals.

Returns:
Number of control intervals

Definition at line 128 of file export_algorithm.cpp.

Returns the number of differential states derivatives.

Returns:
The requested number of differential state derivatives

Returns number of parameters.

Returns:
Number of parameters

Definition at line 122 of file export_algorithm.cpp.

Returns number of parameters.

Returns:
Number of parameters

Definition at line 117 of file export_algorithm.cpp.

Returns number of control inputs.

Returns:
Number of control inputs

Definition at line 111 of file export_algorithm.cpp.

Returns number of differential states.

Returns:
Number of differential states

Definition at line 99 of file export_algorithm.cpp.

Returns number of algebraic states.

Returns:
Number of algebraic states

Definition at line 105 of file export_algorithm.cpp.

Definition at line 138 of file export_algorithm.cpp.

Definition at line 148 of file export_algorithm.cpp.

returnValue ExportAlgorithm::setDimensions ( uint  _NX = 0,
uint  _NU = 0,
uint  _NP = 0,
uint  _NI = 0,
uint  _NOD = 0 
)

Sets the variables dimensions (ODE).

Parameters:
[in]_NXNew number of differential states.
[in]_NUNew number of control inputs.
[in]_NPNew number of parameters.
[in]_NINew number of control intervals. (using _N resulted in a strange error when compiling with cygwin!)
Returns:
SUCCESSFUL_RETURN

Definition at line 65 of file export_algorithm.cpp.

returnValue ExportAlgorithm::setDimensions ( uint  _NX,
uint  _NDX,
uint  _NXA,
uint  _NU,
uint  _NP,
uint  _NI,
uint  _NOD 
)

Sets the variables dimensions (DAE).

Parameters:
[in]_NXNew number of differential states.
[in]_NDXNew number of differential states derivatives.
[in]_NXANew number of algebraic states.
[in]_NUNew number of control inputs.
[in]_NPNew number of parameters.
[in]_NINew number of control intervals.
Returns:
SUCCESSFUL_RETURN

Definition at line 77 of file export_algorithm.cpp.

Definition at line 133 of file export_algorithm.cpp.

void ExportAlgorithm::setNYN ( uint  NYN_)

Definition at line 143 of file export_algorithm.cpp.


Member Data Documentation

std::string ExportAlgorithm::commonHeaderName [protected]

Name of common header file.

Definition at line 217 of file export_algorithm.hpp.

uint ExportAlgorithm::N [protected]

Number of control intervals.

Definition at line 212 of file export_algorithm.hpp.

Number of differential states derivatives.

Definition at line 207 of file export_algorithm.hpp.

Number of "online data" values.

Definition at line 211 of file export_algorithm.hpp.

Number of parameters.

Definition at line 210 of file export_algorithm.hpp.

Number of control inputs.

Definition at line 209 of file export_algorithm.hpp.

Number of differential states.

Definition at line 206 of file export_algorithm.hpp.

Number of algebraic states.

Definition at line 208 of file export_algorithm.hpp.

Number of references/measurements, nodes 0,..., N - 1.

Definition at line 214 of file export_algorithm.hpp.

Number of references/measurements, node N.

Definition at line 215 of file export_algorithm.hpp.


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


acado
Author(s): Milan Vukov, Rien Quirynen
autogenerated on Sat Jun 8 2019 19:40:23