Public Member Functions | Protected Attributes | List of all members

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

#include <export_file.hpp>

Inheritance diagram for ExportFile:
Inheritance graph
[legend]

Public Member Functions

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 ExportStatementclone () 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
 
ExportStatementBlockoperator= (const ExportStatementBlock &rhs)
 
virtual ~ExportStatementBlock ()
 
- Public Member Functions inherited from ExportStatement
virtual ExportStatementacquire (ExportIndex &)
 
virtual ExportStatementallocate (MemoryAllocatorPtr)
 
 ExportStatement ()
 
 ExportStatement (const ExportStatement &arg)
 
ExportStatementoperator= (const ExportStatement &arg)
 
virtual ExportStatementrelease (const ExportIndex &)
 
virtual ~ExportStatement ()
 

Protected Attributes

std::string commentString
 
std::string commonHeaderName
 
std::string fileName
 
std::string intString
 
int precision
 
std::string realString
 
- Protected Attributes inherited from ExportStatementBlock
StatementPtrArray statements
 

Additional Inherited Members

- Public Types inherited from ExportStatement
typedef std::shared_ptr< MemoryAllocatorMemoryAllocatorPtr
 
typedef std::shared_ptr< ExportStatementStatementPtr
 
typedef std::vector< StatementPtrStatementPtrArray
 
- Static Public Attributes inherited from ExportStatement
static std::string fcnPrefix = "acado"
 
static std::string varPrefix = "ACADO"
 

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

Default constructor.

Definition at line 44 of file export_file.cpp.

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

Standard constructor.

@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 47 of file export_file.cpp.

ExportFile::~ExportFile ( )
virtual

Destructor.

Definition at line 58 of file export_file.cpp.

Member Function Documentation

returnValue ExportFile::exportCode ( ) const
virtual

Exports the file containing the auto-generated code.

\return SUCCESSFUL_RETURN

Definition at line 82 of file export_file.cpp.

returnValue ExportFile::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

Setup routine.

    @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.

    \return SUCCESSFUL_RETURN

Definition at line 62 of file export_file.cpp.

Member Data Documentation

std::string ExportFile::commentString
protected

std::string to be used for exporting comments.

Definition at line 119 of file export_file.hpp.

std::string ExportFile::commonHeaderName
protected

Name of common header file.

Definition at line 114 of file export_file.hpp.

std::string ExportFile::fileName
protected

Name of exported file.

Definition at line 113 of file export_file.hpp.

std::string ExportFile::intString
protected

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

Definition at line 117 of file export_file.hpp.

int ExportFile::precision
protected

Number of digits to be used for exporting real values.

Definition at line 118 of file export_file.hpp.

std::string ExportFile::realString
protected

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

Definition at line 116 of file export_file.hpp.


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


acado
Author(s): Milan Vukov, Rien Quirynen
autogenerated on Mon Jun 10 2019 12:35:23