ExportFunctionDeclaration Class Reference

Allows to export code containing function (forward) declarations. More...

#include <export_function_declaration.hpp>

Inheritance diagram for ExportFunctionDeclaration:

Public Member Functions
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
	ExportFunctionDeclaration (const ExportFunction &_f)
	ExportFunctionDeclaration (const ExportAcadoFunction &_f)
virtual	~ExportFunctionDeclaration ()
Public Member Functions inherited from ExportStatement
virtual ExportStatement &	acquire (ExportIndex &)
virtual ExportStatement &	allocate (MemoryAllocatorPtr)
virtual returnValue	exportDataDeclaration (std::ostream &stream, const std::string &_realString="real_t", const std::string &_intString="int", int _precision=16) const
	ExportStatement ()
	ExportStatement (const ExportStatement &arg)
ExportStatement &	operator= (const ExportStatement &arg)
virtual ExportStatement &	release (const ExportIndex &)
virtual	~ExportStatement ()

Private Member Functions
	ExportFunctionDeclaration ()

Private Attributes
const ExportFunction &	f

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 to export code containing function (forward) declarations.

The class ExportDataDeclaration allows to export code containing function (forward) declarations.

Author

Hans Joachim Ferreau, Boris Houska, Milan Vukov

Definition at line 54 of file export_function_declaration.hpp.

Constructor & Destructor Documentation

ExportFunctionDeclaration::ExportFunctionDeclaration

(

const ExportFunction &

_f

)

Constructor taking the function to be declared.

@param[in] _f               Function to be declared.

Definition at line 48 of file export_function_declaration.cpp.

ExportFunctionDeclaration::ExportFunctionDeclaration

(

const ExportAcadoFunction &

_f

)

Constructor taking the ODE function to be declared.

@param[in] _f               ODE function to be declared.

Definition at line 53 of file export_function_declaration.cpp.

ExportFunctionDeclaration::~ExportFunctionDeclaration ( )

virtual

Destructor.

Definition at line 57 of file export_function_declaration.cpp.

BEGIN_NAMESPACE_ACADO ExportFunctionDeclaration::ExportFunctionDeclaration ( )

private

Definition at line 44 of file export_function_declaration.cpp.

Member Function Documentation

ExportStatement * ExportFunctionDeclaration::clone ( ) const

virtual

Clone constructor (deep copy).

\return Pointer to cloned object.

Implements ExportStatement.

Definition at line 60 of file export_function_declaration.cpp.

returnValue ExportFunctionDeclaration::exportCode ( std::ostream &  stream, const std::string &  _realString = "real_t", const std::string &  _intString = "int", int  _precision = 16  ) const

virtual

Exports source code of the statement into given file. Its appearance can can be adjusted by various options.

@param[in] stream                   Name of file to be used to export statement.
@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.

\return SUCCESSFUL_RETURN

Implements ExportStatement.

Definition at line 66 of file export_function_declaration.cpp.

Member Data Documentation

const ExportFunction& ExportFunctionDeclaration::f

private

Definition at line 104 of file export_function_declaration.hpp.

---

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

• export_function_declaration.hpp
• export_function_declaration.cpp