ExportAuxiliaryFunctions Class Reference

A class for generating some helper functions. More...

#include <export_auxiliary_functions.hpp>

Public Member Functions
returnValue	configure ()
	ExportAuxiliaryFunctions (const std::string &_headerFileName, const std::string &_sourceFileName, const std::string &_moduleName="acado", const std::string &_modulePrefix="ACADO", const std::string &_commonHeaderName="", const std::string &_realString="double", const std::string &_intString="int", int _precision=16, const std::string &_commentString=std::string())
returnValue	exportCode ()
virtual	~ExportAuxiliaryFunctions ()

Private Attributes
ExportTemplatedFile	header
std::string	moduleName
std::string	modulePrefix
ExportTemplatedFile	source

Detailed Description

A class for generating some helper functions.

Author

Milan Vukov

Definition at line 46 of file export_auxiliary_functions.hpp.

Constructor & Destructor Documentation

BEGIN_NAMESPACE_ACADO ExportAuxiliaryFunctions::ExportAuxiliaryFunctions	(	const std::string &	_headerFileName,
		const std::string &	_sourceFileName,
		const std::string &	_moduleName = "acado",
		const std::string &	_modulePrefix = "ACADO",
		const std::string &	_commonHeaderName = "",
		const std::string &	_realString = "double",
		const std::string &	_intString = "int",
		int	_precision = 16,
		const std::string &	_commentString = std::string()
	)

Default constructor.

@param[in] _moduleName              Module name for customization.

Parameters

[in]	_moduleName	Module prefix for customization.
[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 40 of file export_auxiliary_functions.cpp.

virtual ExportAuxiliaryFunctions::~ExportAuxiliaryFunctions ( )

inlinevirtual

Destructor.

Definition at line 74 of file export_auxiliary_functions.hpp.

Member Function Documentation

returnValue ExportAuxiliaryFunctions::configure

(

)

Configure the template

Returns

SUCCESSFUL_RETURN

Definition at line 57 of file export_auxiliary_functions.cpp.

returnValue ExportAuxiliaryFunctions::exportCode

(

)

Export the interface.

Definition at line 79 of file export_auxiliary_functions.cpp.

Member Data Documentation

ExportTemplatedFile ExportAuxiliaryFunctions::header

private

Definition at line 89 of file export_auxiliary_functions.hpp.

std::string ExportAuxiliaryFunctions::moduleName

private

Definition at line 90 of file export_auxiliary_functions.hpp.

std::string ExportAuxiliaryFunctions::modulePrefix

private

Definition at line 91 of file export_auxiliary_functions.hpp.

ExportTemplatedFile ExportAuxiliaryFunctions::source

private

Definition at line 88 of file export_auxiliary_functions.hpp.

---

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

• export_auxiliary_functions.hpp
• export_auxiliary_functions.cpp