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

#include <export_argument_list.hpp>

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

ExportArgumentList &	operator= (const ExportArgumentList &rhs)

virtual	~ExportArgumentList ()

Protected Member Functions
returnValue	addSingleArgument (const ExportArgument &_argument)

Protected Attributes
std::vector< ExportArgument >	arguments

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

BEGIN_NAMESPACE_ACADO ExportArgumentList::ExportArgumentList ( )

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

@param[in] _argument1       Calling argument no. 1.
@param[in] _argument2       Calling argument no. 2.
@param[in] _argument3       Calling argument no. 3.
@param[in] _argument4       Calling argument no. 4.
@param[in] _argument5       Calling argument no. 5.
@param[in] _argument6       Calling argument no. 6.
@param[in] _argument7       Calling argument no. 7.
@param[in] _argument8       Calling argument no. 8.
@param[in] _argument9       Calling argument no. 9.

Definition at line 50 of file export_argument_list.cpp.

ExportArgumentList::ExportArgumentList ( const ExportArgumentList & arg )

Copy constructor (deep copy).

@param[in] arg      Right-hand side object.

Definition at line 67 of file export_argument_list.cpp.

ExportArgumentList::~ExportArgumentList ( )

virtual

Destructor.

Definition at line 75 of file export_argument_list.cpp.

Member Function Documentation

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

Adds up to nine calling arguments to the list.

@param[in] _argument1       Calling argument no. 1.
@param[in] _argument2       Calling argument no. 2.
@param[in] _argument3       Calling argument no. 3.
@param[in] _argument4       Calling argument no. 4.
@param[in] _argument5       Calling argument no. 5.
@param[in] _argument6       Calling argument no. 6.
@param[in] _argument7       Calling argument no. 7.
@param[in] _argument8       Calling argument no. 8.
@param[in] _argument9       Calling argument no. 9.

\return SUCCESSFUL_RETURN

Definition at line 97 of file export_argument_list.cpp.

returnValue ExportArgumentList::addSingleArgument ( const ExportArgument & _argument )

protected

Adds a single calling arguments to the list.

@param[in] _argument        Calling argument.

\return SUCCESSFUL_RETURN

Definition at line 198 of file export_argument_list.cpp.

returnValue ExportArgumentList::clear ( )

Removes all calling arguments to yield an empty argument list.

\return SUCCESSFUL_RETURN

Definition at line 170 of file export_argument_list.cpp.

returnValue ExportArgumentList::doIncludeType ( )

Specifies to include variable types into calling arguments.

\return SUCCESSFUL_RETURN

Definition at line 179 of file export_argument_list.cpp.

returnValue ExportArgumentList::doNotIncludeType ( )

Specifies not to include variable types into calling arguments.

\return 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.

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

Definition at line 129 of file export_argument_list.cpp.

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

Get the list of arguments.

\return Argument list

Definition at line 211 of file export_argument_list.cpp.

uint ExportArgumentList::getNumArguments ( ) const

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

@param[in] arg      Right-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.

bool ExportArgumentList::includeType

protected

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:

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation