Public Member Functions | Protected Member Functions | Protected Attributes

Allows to store a list of calling arguments of an ExportFunction. More...

#include <export_argument_list.hpp>

List of all members.

Public Member Functions

returnValue addArgument (const ExportArgument &_argument1, 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 clear ()
returnValue doIncludeType ()
returnValue doNotIncludeType ()
 ExportArgumentList ()
 ExportArgumentList (const ExportArgument &_argument1, 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)
 ExportArgumentList (const ExportArgumentList &arg)
virtual returnValue exportCode (std::ostream &stream, const std::string &_realString="real_t", const std::string &_intString="int", int _precision=16) const
const std::vector
< ExportArgument > & 
get () const
uint getNumArguments () const
ExportArgumentListoperator= (const ExportArgumentList &rhs)
virtual ~ExportArgumentList ()

Protected Member Functions

returnValue addSingleArgument (const ExportArgument &_argument)

Protected Attributes

std::vector< ExportArgumentarguments
bool includeType

Detailed Description

Allows to store a list of calling arguments of an ExportFunction.

The class ExportArgumentList allows to store a list of calling arguments of an ExportFunction.

Author:
Hans Joachim Ferreau, Boris Houska

Definition at line 54 of file export_argument_list.hpp.


Constructor & Destructor Documentation

< Default Constructor.

Definition at line 44 of file export_argument_list.cpp.

ExportArgumentList::ExportArgumentList ( const ExportArgument _argument1,
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 
)

Constructor which takes up to nine calling arguments.

Parameters:
[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 50 of file export_argument_list.cpp.

Copy constructor (deep copy).

Parameters:
[in]argRight-hand side object.

Definition at line 67 of file export_argument_list.cpp.

Destructor.

Definition at line 75 of file export_argument_list.cpp.


Member Function Documentation

Adds up to nine calling arguments to the list.

Parameters:
[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 97 of file export_argument_list.cpp.

Adds a single calling arguments to the list.

Parameters:
[in]_argumentCalling argument.
Returns:
SUCCESSFUL_RETURN

Definition at line 198 of file export_argument_list.cpp.

Removes all calling arguments to yield an empty argument list.

Returns:
SUCCESSFUL_RETURN

Definition at line 170 of file export_argument_list.cpp.

Specifies to include variable types into calling arguments.

Returns:
SUCCESSFUL_RETURN

Definition at line 179 of file export_argument_list.cpp.

Specifies not to include variable types into calling arguments.

Returns:
SUCCESSFUL_RETURN

Definition at line 186 of file export_argument_list.cpp.

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

Exports a code snippet containing all calling arguments of the list. Its appearance can can be adjusted by various options.

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

Definition at line 129 of file export_argument_list.cpp.

const std::vector< ExportArgument > & ExportArgumentList::get ( ) const

Get the list of arguments.

Returns:
Argument list

Definition at line 211 of file export_argument_list.cpp.

Return number of calling arguments in list.

Returns:
Number of calling arguments

Definition at line 122 of file export_argument_list.cpp.

ExportArgumentList & ExportArgumentList::operator= ( const ExportArgumentList rhs)

Assignment operator (deep copy).

Parameters:
[in]argRight-hand side object.

Definition at line 81 of file export_argument_list.cpp.


Member Data Documentation

std::vector< ExportArgument > ExportArgumentList::arguments [protected]

Array containing all calling arguments.

Definition at line 204 of file export_argument_list.hpp.

Flag indicating whether variable types are to be included in calling arguments.

Definition at line 207 of file export_argument_list.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:23