ACADO Toolkit
1.2.0beta
Toolkit for Automatic Control and Dynamic Optimization
|
Allows to store a list of calling arguments of an ExportFunction. More...
#include <export_argument_list.hpp>
Public Member Functions | |
ExportArgumentList () | |
< Default Constructor. | |
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. | |
ExportArgumentList (const ExportArgumentList &arg) | |
Copy constructor (deep copy). | |
virtual | ~ExportArgumentList () |
Destructor. | |
ExportArgumentList & | operator= (const ExportArgumentList &rhs) |
Assignment operator (deep copy). | |
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) |
Adds up to nine calling arguments to the list. | |
uint | getNumArguments () const |
Return number of calling arguments in list. | |
virtual returnValue | exportCode (FILE *file, const String &_realString="real_t", const String &_intString="int", int _precision=16) const |
Exports a code snippet containing all calling arguments of the list. | |
returnValue | clear () |
Removes all calling arguments to yield an empty argument list. | |
returnValue | doIncludeType () |
Specifies to include variable types into calling arguments. | |
returnValue | doNotIncludeType () |
Specifies not to include variable types into calling arguments. | |
const std::vector < ExportArgument > & | get () const |
Get the list of arguments. | |
Protected Member Functions | |
returnValue | addSingleArgument (const ExportArgument &_argument) |
Adds a single calling arguments to the list. | |
Protected Attributes | |
std::vector< ExportArgument > | arguments |
Array containing all calling arguments. | |
BooleanType | includeType |
Flag indicating whether variable types are to be included in calling arguments. |
The class ExportArgumentList allows to store a list of calling arguments of an ExportFunction.
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 |
||
) |
[in] | _argument1 | Calling argument no. 1. |
[in] | _argument2 | Calling argument no. 2. |
[in] | _argument3 | Calling argument no. 3. |
[in] | _argument4 | Calling argument no. 4. |
[in] | _argument5 | Calling argument no. 5. |
[in] | _argument6 | Calling argument no. 6. |
[in] | _argument7 | Calling argument no. 7. |
[in] | _argument8 | Calling argument no. 8. |
[in] | _argument9 | Calling argument no. 9. |
References addArgument().
ExportArgumentList::ExportArgumentList | ( | const ExportArgumentList & | arg | ) |
[in] | arg | Right-hand side object. |
References arguments, and includeType.
ExportArgumentList::~ExportArgumentList | ( | ) | [virtual] |
References clear().
returnValue ExportArgumentList::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 |
||
) |
[in] | _argument1 | Calling argument no. 1. |
[in] | _argument2 | Calling argument no. 2. |
[in] | _argument3 | Calling argument no. 3. |
[in] | _argument4 | Calling argument no. 4. |
[in] | _argument5 | Calling argument no. 5. |
[in] | _argument6 | Calling argument no. 6. |
[in] | _argument7 | Calling argument no. 7. |
[in] | _argument8 | Calling argument no. 8. |
[in] | _argument9 | Calling argument no. 9. |
References addSingleArgument(), and SUCCESSFUL_RETURN.
Referenced by ExportFunction::addArgument(), ExportArgumentList(), and ExportFunctionCall::init().
returnValue ExportArgumentList::addSingleArgument | ( | const ExportArgument & | _argument | ) | [protected] |
[in] | _argument | Calling argument. |
References arguments, ExportArgument::getDim(), and SUCCESSFUL_RETURN.
Referenced by addArgument().
References doIncludeType(), and SUCCESSFUL_RETURN.
Referenced by ExportFunctionCall::clear(), operator=(), and ~ExportArgumentList().
References BT_TRUE, includeType, and SUCCESSFUL_RETURN.
Referenced by clear(), and ExportArgumentList().
References BT_FALSE, includeType, and SUCCESSFUL_RETURN.
Referenced by ExportFunctionCall::clear().
returnValue ExportArgumentList::exportCode | ( | FILE * | file, |
const String & | _realString = "real_t" , |
||
const String & | _intString = "int" , |
||
int | _precision = 16 |
||
) | const [virtual] |
Its appearance can can be adjusted by various options.
[in] | file | Name of file to be used to export function. |
[in] | _realString | String to be used to declare real variables. |
[in] | _intString | String to be used to declare integer variables. |
[in] | _precision | Number of digits to be used for exporting real values. |
References acadoFPrintf(), arguments, BT_FALSE, BT_TRUE, includeType, INT, STATIC_CONST_INT, STATIC_CONST_REAL, and SUCCESSFUL_RETURN.
Referenced by ExportFunctionCall::exportCode(), ExportFunction::exportCode(), and ExportFunction::exportForwardDeclaration().
const std::vector< ExportArgument > & ExportArgumentList::get | ( | ) | const |
References arguments.
Referenced by ExportFunction::exportForwardDeclaration().
uint ExportArgumentList::getNumArguments | ( | ) | const |
References arguments.
Referenced by ExportFunction::exportForwardDeclaration(), ExportFunction::getNumArguments(), and ExportFunctionCall::init().
ExportArgumentList & ExportArgumentList::operator= | ( | const ExportArgumentList & | rhs | ) |
[in] | arg | Right-hand side object. |
References arguments, clear(), and includeType.
std::vector< ExportArgument > ExportArgumentList::arguments [protected] |
Referenced by addSingleArgument(), ExportArgumentList(), exportCode(), get(), getNumArguments(), and operator=().
BooleanType ExportArgumentList::includeType [protected] |
Referenced by doIncludeType(), doNotIncludeType(), ExportArgumentList(), exportCode(), and operator=().