Public Member Functions | Protected Member Functions | Protected Attributes

Allows to export code of a function call. More...

#include <export_function_call.hpp>

Inheritance diagram for ExportFunctionCall:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual ExportStatementclone () const
virtual returnValue exportCode (std::ostream &stream, const std::string &_realString="real_t", const std::string &_intString="int", int _precision=16) const
 ExportFunctionCall (const std::string &_name="acadoFcn", 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)
 ExportFunctionCall (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)
 ExportFunctionCall (const ExportFunctionCall &arg)
returnValue init (const std::string &_name="defaultFunctionName", 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 init (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)
ExportFunctionCalloperator= (const ExportFunctionCall &arg)
virtual ~ExportFunctionCall ()

Protected Member Functions

returnValue clear ()
returnValue setName (const std::string &_name)

Protected Attributes

ExportArgumentList functionArguments
std::string name

Detailed Description

Allows to export code of a function call.

The class ExportFunctionCall allows to export code of a function call.

Author:
Hans Joachim Ferreau, Boris Houska

Definition at line 57 of file export_function_call.hpp.


Constructor & Destructor Documentation

BEGIN_NAMESPACE_ACADO ExportFunctionCall::ExportFunctionCall ( const std::string &  _name = "acadoFcn",
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 
)

Default constructor which optionally takes the name of the function to be called as well as possible calling arguments.

Parameters:
[in]_nameName of the function to be called.
[in]_argument1Calling argument no. 1.
[in]_argument2Calling argument no. 2.
[in]_argument3Calling argument no. 3.
[in]_argument4Calling argument no. 4.
[in]_argument5Calling argument no. 5.
[in]_argument6Calling argument no. 6.
[in]_argument7Calling argument no. 7.
[in]_argument8Calling argument no. 8.
[in]_argument9Calling argument no. 9.

Definition at line 44 of file export_function_call.cpp.

Constructor which optionally takes the function to be called as well as possible calling arguments.

Parameters:
[in]_fFunction to be called.
[in]_argument1Calling argument no. 1.
[in]_argument2Calling argument no. 2.
[in]_argument3Calling argument no. 3.
[in]_argument4Calling argument no. 4.
[in]_argument5Calling argument no. 5.
[in]_argument6Calling argument no. 6.
[in]_argument7Calling argument no. 7.
[in]_argument8Calling argument no. 8.
[in]_argument9Calling argument no. 9.

Definition at line 63 of file export_function_call.cpp.

Copy constructor (deep copy).

Parameters:
[in]argRight-hand side object.

Definition at line 82 of file export_function_call.cpp.

Destructor.

Definition at line 90 of file export_function_call.cpp.


Member Function Documentation

Frees internal dynamic memory to yield an empty function call.

Returns:
SUCCESSFUL_RETURN

Definition at line 202 of file export_function_call.cpp.

Clone constructor (deep copy).

Returns:
Pointer to cloned object.

Implements ExportStatement.

Definition at line 110 of file export_function_call.cpp.

returnValue ExportFunctionCall::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 function call into given file. Its appearance can can be adjusted by various options.

Parameters:
[in]streamName of file to be used to export function call.
[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.
Returns:
SUCCESSFUL_RETURN,
RET_MEMBER_NOT_INITIALISED

Implements ExportStatement.

Definition at line 180 of file export_function_call.cpp.

returnValue ExportFunctionCall::init ( const std::string &  _name = "defaultFunctionName",
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 
)

Initializes function call with given name of the function and possible calling arguments.

Parameters:
[in]_nameName of the function to be called.
[in]_argument1Calling argument no. 1.
[in]_argument2Calling argument no. 2.
[in]_argument3Calling argument no. 3.
[in]_argument4Calling argument no. 4.
[in]_argument5Calling argument no. 5.
[in]_argument6Calling argument no. 6.
[in]_argument7Calling argument no. 7.
[in]_argument8Calling argument no. 8.
[in]_argument9Calling argument no. 9.
Returns:
SUCCESSFUL_RETURN

Definition at line 117 of file export_function_call.cpp.

Initializes function call with function to be called and possible calling arguments.

Parameters:
[in]_fFunction to be called.
[in]_argument1Calling argument no. 1.
[in]_argument2Calling argument no. 2.
[in]_argument3Calling argument no. 3.
[in]_argument4Calling argument no. 4.
[in]_argument5Calling argument no. 5.
[in]_argument6Calling argument no. 6.
[in]_argument7Calling argument no. 7.
[in]_argument8Calling argument no. 8.
[in]_argument9Calling argument no. 9.
Returns:
SUCCESSFUL_RETURN,
RET_INVALID_CALL_TO_EXPORTED_FUNCTION

Definition at line 141 of file export_function_call.cpp.

ExportFunctionCall & ExportFunctionCall::operator= ( const ExportFunctionCall arg)

Assignment operator (deep copy).

Parameters:
[in]argRight-hand side object.

Definition at line 96 of file export_function_call.cpp.

returnValue ExportFunctionCall::setName ( const std::string &  _name) [protected]

Sets the name of the function to be called.

Parameters:
[in]_nameNew name of the function to be called.
Returns:
SUCCESSFUL_RETURN

Definition at line 212 of file export_function_call.cpp.


Member Data Documentation

List of calling arguments.

Definition at line 240 of file export_function_call.hpp.

std::string ExportFunctionCall::name [protected]

Name of function to be called.

Definition at line 239 of file export_function_call.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