Public Member Functions | Protected Member Functions | Protected Attributes | Friends

Allows export of template files. More...

#include <export_templated_file.hpp>

Inheritance diagram for ExportTemplatedFile:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual returnValue configure ()
 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 ~ExportTemplatedFile ()

Protected Member Functions

returnValue fillTemplate ()

Protected Attributes

std::map< std::string,
std::string > 
dictionary
std::string folders
std::string templateName

Friends

class ExportAuxiliaryFunctions
class ExportAuxiliarySimFunctions
class ExportHessianRegularization
class ExportQpOasesInterface
class ExportSimulinkInterface

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 ( 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() 
)

Default constructor.

Parameters:
[in]_templateNameName of a template.
[in]_fileNameName of exported file.
[in]_commonHeaderNameName of common header file to be included.
[in]_realStringstd::string to be used to declare real variables.
[in]_intStringstd::string to be used to declare integer variables.
[in]_precisionNumber of digits to be used for exporting real values.
[in]_commentStringstd::string to be used for exporting comments.
Returns:
SUCCESSFUL_RETURN

Definition at line 41 of file export_templated_file.cpp.

virtual ExportTemplatedFile::~ExportTemplatedFile ( ) [inline, virtual]

Destructor.

Definition at line 84 of file export_templated_file.hpp.


Member Function Documentation

virtual returnValue ExportTemplatedFile::configure ( ) [inline, virtual]

Configure the template

Returns:
SUCCESSFUL_RETURN

Definition at line 91 of file export_templated_file.hpp.

Fill in the template.

Definition at line 54 of file export_templated_file.cpp.


Friends And Related Function Documentation

friend class ExportAuxiliaryFunctions [friend]

Definition at line 58 of file export_templated_file.hpp.

friend class ExportAuxiliarySimFunctions [friend]

Definition at line 60 of file export_templated_file.hpp.

friend class ExportHessianRegularization [friend]

Definition at line 59 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 57 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 103 of file export_templated_file.hpp.

std::string ExportTemplatedFile::folders [protected]

List of folders where templates are stored.

Definition at line 105 of file export_templated_file.hpp.

std::string ExportTemplatedFile::templateName [protected]

Name of the template file.

Definition at line 101 of file export_templated_file.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:24