ExportModule Class Reference

User-interface to automatically generate algorithms for fast model predictive control. More...

#include <export_module.hpp>

Inheritance diagram for ExportModule:

List of all members.

Public Member Functions
virtual returnValue	exportCode (const std::string &dirName, const std::string &_realString="real_t", const std::string &_intString="int", int _precision=16)=0
	ExportModule ()
virtual	~ExportModule ()
Protected Member Functions
virtual returnValue	collectDataDeclarations (ExportStatementBlock &declarations, ExportStruct dataStruct=ACADO_ANY) const =0
virtual returnValue	collectFunctionDeclarations (ExportStatementBlock &declarations) const =0
virtual returnValue	exportAcadoHeader (const std::string &_dirName, const std::string &_fileName, const std::string &_realString="real_t", const std::string &_intString="int", int _precision=16) const =0
returnValue	setupOptions ()
Protected Attributes
std::string	commonHeaderName

---

Detailed Description

User-interface to automatically generate algorithms for fast model predictive control.

The class ExportModule is a user-interface to automatically generate tailored algorithms for fast model predictive control. It takes an optimal control problem (OCP) formulation and generates code based on given user options.

Author:

Hans Joachim Ferreau, Boris Houska

Definition at line 55 of file export_module.hpp.

---

Constructor & Destructor Documentation

BEGIN_NAMESPACE_ACADO ExportModule::ExportModule

(

)

Default constructor.

Definition at line 44 of file export_module.cpp.

ExportModule::~ExportModule

(

)

[virtual]

Destructor.

Definition at line 52 of file export_module.cpp.

---

Member Function Documentation

virtual returnValue ExportModule::collectDataDeclarations	(	ExportStatementBlock &	declarations,
		ExportStruct	dataStruct = ACADO_ANY
	)		const [protected, pure virtual]

Collects all data declarations of the auto-generated sub-modules to given list of declarations.

Parameters:

[in]

declarations

List of declarations.

Returns:

SUCCESSFUL_RETURN,
RET_UNABLE_TO_EXPORT_CODE

Implemented in SIMexport, and OCPexport.

virtual returnValue ExportModule::collectFunctionDeclarations

(

ExportStatementBlock &

declarations

)

const [protected, pure virtual]

Collects all function (forward) declarations of the auto-generated sub-modules to given list of declarations.

Parameters:

[in]

declarations

List of declarations.

Returns:

SUCCESSFUL_RETURN,
RET_UNABLE_TO_EXPORT_CODE

Implemented in SIMexport, and OCPexport.

virtual returnValue ExportModule::exportAcadoHeader	(	const std::string &	_dirName,
		const std::string &	_fileName,
		const std::string &	_realString = "real_t",
		const std::string &	_intString = "int",
		int	_precision = 16
	)		const [protected, pure virtual]

Exports main header file for using the exported algorithm.

Parameters:

[in]	_dirName	Name of directory to be used to export file.
[in]	_fileName	Name of file to be exported.
[in]	_realString	std::string to be used to declare real variables.
[in]	_intString	std::string to be used to declare integer variables.
[in]	_precision	Number of digits to be used for exporting real values.

Returns:

SUCCESSFUL_RETURN

Implemented in OCPexport, and SIMexport.

virtual returnValue ExportModule::exportCode	(	const std::string &	dirName,
		const std::string &	_realString = "real_t",
		const std::string &	_intString = "int",
		int	_precision = 16
	)		[pure virtual]

Exports all files of the auto-generated code into the given directory.

Parameters:

[in]	dirName	Name of directory to be used to export files.
[in]	_realString	std::string to be used to declare real variables.
[in]	_intString	std::string to be used to declare integer variables.
[in]	_precision	Number of digits to be used for exporting real values.

Returns:

SUCCESSFUL_RETURN

Implemented in SIMexport, and OCPexport.

returnValue ExportModule::setupOptions

(

)

[protected, virtual]

Sets-up default options.

Returns:

SUCCESSFUL_RETURN

Reimplemented from Options.

Definition at line 59 of file export_module.cpp.

---

Member Data Documentation

std::string ExportModule::commonHeaderName [protected]

Name of common header file.

Definition at line 135 of file export_module.hpp.

---

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

• export_module.hpp
• export_module.cpp