ExportTemplatedFile Class Reference

Allows export of template files. More...

#include <export_templated_file.hpp>

Inheritance diagram for ExportTemplatedFile:

Public Member Functions
virtual returnValue	configure ()
	ExportTemplatedFile ()
	ExportTemplatedFile (const std::string &_templateName, 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 returnValue	setup (const std::string &_templateName, 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	~ExportTemplatedFile ()
Public Member Functions inherited from ExportFile
virtual returnValue	exportCode () const
	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())
virtual returnValue	setup (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 ()
Public Member Functions inherited from ExportStatementBlock
returnValue	addComment (const std::string &_comment)
returnValue	addComment (uint _nBlanks, const std::string &_comment)
returnValue	addDeclaration (const ExportVariable &_data, ExportStruct _dataStruct=ACADO_ANY)
returnValue	addDeclaration (const ExportIndex &_data, ExportStruct _dataStruct=ACADO_ANY)
returnValue	addDeclaration (const ExportFunction &_f)
returnValue	addDeclaration (const ExportAcadoFunction &_f)
returnValue	addFunction (const ExportFunction &_function)
returnValue	addFunctionCall (const std::string &_fName, const ExportArgument &_argument1=emptyConstExportArgument, const ExportArgument &_argument2=emptyConstExportArgument, const ExportArgument &_argument3=emptyConstExportArgument, const ExportArgument &_argument4=emptyConstExportArgument, const ExportArgument &_argument5=emptyConstExportArgument, const ExportArgument &_argument6=emptyConstExportArgument, const ExportArgument &_argument7=emptyConstExportArgument, const ExportArgument &_argument8=emptyConstExportArgument, const ExportArgument &_argument9=emptyConstExportArgument)
returnValue	addFunctionCall (const ExportFunction &_f, const ExportArgument &_argument1=emptyConstExportArgument, const ExportArgument &_argument2=emptyConstExportArgument, const ExportArgument &_argument3=emptyConstExportArgument, const ExportArgument &_argument4=emptyConstExportArgument, const ExportArgument &_argument5=emptyConstExportArgument, const ExportArgument &_argument6=emptyConstExportArgument, const ExportArgument &_argument7=emptyConstExportArgument, const ExportArgument &_argument8=emptyConstExportArgument, const ExportArgument &_argument9=emptyConstExportArgument)
returnValue	addLinebreak (uint num=1)
returnValue	addStatement (const ExportStatement &_statement)
returnValue	addStatement (const std::string &_statementString)
returnValue	clear ()
virtual ExportStatement *	clone () const
virtual returnValue	exportCode (std::ostream &stream, const std::string &_realString="real_t", const std::string &_intString="int", int _precision=16) const
virtual returnValue	exportDataDeclaration (std::ostream &stream, const std::string &_realString="real_t", const std::string &_intString="int", int _precision=16) const
	ExportStatementBlock ()
	ExportStatementBlock (const ExportStatementBlock &arg)
uint	getNumStatements () const
ExportStatementBlock &	operator= (const ExportStatementBlock &rhs)
virtual	~ExportStatementBlock ()
Public Member Functions inherited from ExportStatement
virtual ExportStatement &	acquire (ExportIndex &)
virtual ExportStatement &	allocate (MemoryAllocatorPtr)
	ExportStatement ()
	ExportStatement (const ExportStatement &arg)
ExportStatement &	operator= (const ExportStatement &arg)
virtual ExportStatement &	release (const ExportIndex &)
virtual	~ExportStatement ()

Protected Member Functions
returnValue	fillTemplate ()

Protected Attributes
std::map< std::string, std::string >	dictionary
std::string	folders
std::string	templateName
Protected Attributes inherited from ExportFile
std::string	commentString
std::string	commonHeaderName
std::string	fileName
std::string	intString
int	precision
std::string	realString
Protected Attributes inherited from ExportStatementBlock
StatementPtrArray	statements

Friends
class	ExportAuxiliaryFunctions
class	ExportAuxiliarySimFunctions
class	ExportHessianRegularization
class	ExportQpOases3Interface
class	ExportQpOasesInterface
class	ExportSimulinkInterface
class	OCPexport
class	SIMexport

Additional Inherited Members
Public Types inherited from ExportStatement
typedef std::shared_ptr< MemoryAllocator >	MemoryAllocatorPtr
typedef std::shared_ptr< ExportStatement >	StatementPtr
typedef std::vector< StatementPtr >	StatementPtrArray
Static Public Attributes inherited from ExportStatement
static std::string	fcnPrefix = "acado"
static std::string	varPrefix = "ACADO"

Detailed Description

Allows export of template files.

Author

Milan Vukov

Definition at line 52 of file export_templated_file.hpp.

Constructor & Destructor Documentation

BEGIN_NAMESPACE_ACADO ExportTemplatedFile::ExportTemplatedFile

(

)

Default constructor.

Definition at line 41 of file export_templated_file.cpp.

ExportTemplatedFile::ExportTemplatedFile	(	const std::string &	_templateName,
		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()
	)

Standard constructor.

@param[in] _templateName            Name of a template.
@param[in] _fileName                        Name of exported file.
@param[in] _commonHeaderName        Name of common header file to be included.
@param[in] _realString                      std::string to be used to declare real variables.
@param[in] _intString                       std::string to be used to declare integer variables.
@param[in] _precision                       Number of digits to be used for exporting real values.
@param[in] _commentString           std::string to be used for exporting comments.

Definition at line 45 of file export_templated_file.cpp.

virtual ExportTemplatedFile::~ExportTemplatedFile ( )

inlinevirtual

Destructor.

Definition at line 90 of file export_templated_file.hpp.

Member Function Documentation

virtual returnValue ExportTemplatedFile::configure ( )

inlinevirtual

Configure the template

Returns

SUCCESSFUL_RETURN

Definition at line 120 of file export_templated_file.hpp.

returnValue ExportTemplatedFile::fillTemplate ( )

protected

Fill in the template.

Definition at line 76 of file export_templated_file.cpp.

returnValue ExportTemplatedFile::setup ( const std::string &  _templateName, 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

Default constructor.

@param[in] _templateName                Name of a template.
@param[in] _fileName                    Name of exported file.
@param[in] _commonHeaderName    Name of common header file to be included.
@param[in] _realString                  std::string to be used to declare real variables.
@param[in] _intString                   std::string to be used to declare integer variables.
@param[in] _precision                   Number of digits to be used for exporting real values.
@param[in] _commentString               std::string to be used for exporting comments.

Returns

SUCCESSFUL_RETURN

Definition at line 58 of file export_templated_file.cpp.

Friends And Related Function Documentation

friend class ExportAuxiliaryFunctions

friend

Definition at line 59 of file export_templated_file.hpp.

friend class ExportAuxiliarySimFunctions

friend

Definition at line 61 of file export_templated_file.hpp.

friend class ExportHessianRegularization

friend

Definition at line 60 of file export_templated_file.hpp.

friend class ExportQpOases3Interface

friend

Definition at line 57 of file export_templated_file.hpp.

friend class ExportQpOasesInterface

friend

Definition at line 56 of file export_templated_file.hpp.

friend class ExportSimulinkInterface

friend

Definition at line 58 of file export_templated_file.hpp.

friend class OCPexport

friend

Definition at line 62 of file export_templated_file.hpp.

friend class SIMexport

friend

Definition at line 63 of file export_templated_file.hpp.

Member Data Documentation

std::map< std::string, std::string > ExportTemplatedFile::dictionary

protected

Dictionary used to fill in the template file.

Definition at line 132 of file export_templated_file.hpp.

std::string ExportTemplatedFile::folders

protected

List of folders where templates are stored.

Definition at line 134 of file export_templated_file.hpp.

std::string ExportTemplatedFile::templateName

protected

Name of the template file.

Definition at line 130 of file export_templated_file.hpp.

---

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

• export_templated_file.hpp
• export_templated_file.cpp