ExportFile Class Reference

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

#include <export_file.hpp>

Inheritance diagram for ExportFile:

List of all members.

Public Member Functions
virtual returnValue	exportCode () const
	ExportFile (const std::string &_fileName, const std::string &_commonHeaderName="", const std::string &_realString="real_t", const std::string &_intString="int", int _precision=16, const std::string &_commentString=std::string())
virtual	~ExportFile ()
Protected Attributes
std::string	commentString
std::string	commonHeaderName
std::string	fileName
std::string	intString
int	precision
std::string	realString

---

Detailed Description

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

The class ExportFile allows to export files containing automatically generated algorithms for fast model predictive control.

Author:

Hans Joachim Ferreau, Milan Vukov, Boris Houska

Definition at line 52 of file export_file.hpp.

---

Constructor & Destructor Documentation

BEGIN_NAMESPACE_ACADO ExportFile::ExportFile	(	const std::string &	_fileName,
		const std::string &	_commonHeaderName = "",
		const std::string &	_realString = "real_t",
		const std::string &	_intString = "int",
		int	_precision = 16,
		const std::string &	_commentString = std::string()
	)

Default constructor.

Parameters:

[in]	_fileName	Name of exported file.
[in]	_commonHeaderName	Name of common header file to be included.
[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.
[in]	_commentString	std::string to be used for exporting comments.

Returns:

SUCCESSFUL_RETURN

Definition at line 45 of file export_file.cpp.

ExportFile::~ExportFile

(

)

[virtual]

Destructor.

Definition at line 62 of file export_file.cpp.

---

Member Function Documentation

returnValue ExportFile::exportCode

(

)

const [virtual]

Exports the file containing the auto-generated code.

Returns:

SUCCESSFUL_RETURN

Definition at line 65 of file export_file.cpp.

---

Member Data Documentation

std::string ExportFile::commentString [protected]

std::string to be used for exporting comments.

Definition at line 96 of file export_file.hpp.

std::string ExportFile::commonHeaderName [protected]

Name of common header file.

Definition at line 91 of file export_file.hpp.

std::string ExportFile::fileName [protected]

Name of exported file.

Definition at line 90 of file export_file.hpp.

std::string ExportFile::intString [protected]

std::string to be used to declare integer variables.

Definition at line 94 of file export_file.hpp.

int ExportFile::precision [protected]

Number of digits to be used for exporting real values.

Definition at line 95 of file export_file.hpp.

std::string ExportFile::realString [protected]

std::string to be used to declare real variables.

Definition at line 93 of file export_file.hpp.

---

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

• export_file.hpp
• export_file.cpp