Public Member Functions

Defines a matrix-valued variable that can be passed as argument to exported functions. More...

#include <export_argument.hpp>

Inheritance diagram for ExportArgument:
Inheritance graph
[legend]

List of all members.

Public Member Functions

returnValue callByValue ()
 ExportArgument ()
 ExportArgument (const std::string &_name, uint _nRows=1, uint _nCols=1, ExportType _type=REAL, ExportStruct _dataStruct=ACADO_LOCAL, bool _callByValue=false, const ExportIndex &_addressIdx=emptyConstExportIndex, const std::string &_prefix=std::string())
 ExportArgument (const std::string &_name, const DMatrixPtr &_data, ExportType _type=REAL, ExportStruct _dataStruct=ACADO_LOCAL, bool _callByValue=false, const ExportIndex &_addressIdx=emptyConstExportIndex, const std::string &_prefix=std::string())
 ExportArgument (const DMatrix &_data)
virtual returnValue exportDataDeclaration (std::ostream &stream, const std::string &_realString="real_t", const std::string &_intString="int", int _precision=16) const
ExportArgument getAddress (const ExportIndex &_rowIdx, const ExportIndex &_colIdx=emptyConstExportIndex) const
const std::string getAddressString (bool withDataStruct=true) const
virtual uint getDim () const
virtual uint getNumCols () const
virtual uint getNumRows () const
bool isCalledByValue () const
virtual bool isGiven () const
ExportArgumentInternaloperator-> ()
const ExportArgumentInternaloperator-> () const

Detailed Description

Defines a matrix-valued variable that can be passed as argument to exported functions.

The class ExportArgument defines a matrix-valued variable that can be passed as argument to exported functions. By default, all entries of an arguments are undefined, but each of its component can be set to a fixed value if known beforehand.

Author:
Hans Joachim Ferreau, Boris Houska, Milan Vukov

Definition at line 61 of file export_argument.hpp.


Constructor & Destructor Documentation

Default constructor.

Definition at line 47 of file export_argument.cpp.

ExportArgument::ExportArgument ( const std::string &  _name,
uint  _nRows = 1,
uint  _nCols = 1,
ExportType  _type = REAL,
ExportStruct  _dataStruct = ACADO_LOCAL,
bool  _callByValue = false,
const ExportIndex _addressIdx = emptyConstExportIndex,
const std::string &  _prefix = std::string() 
)

Constructor which takes the name, type and dimensions of the argument.

Parameters:
[in]_nameName of the argument.
[in]_nRowsNumber of rows of the argument.
[in]_nColsNumber of columns of the argument.
[in]_typeData type of the argument.
[in]_dataStructGlobal data struct to which the argument belongs to (if any).
[in]_callByValueFlag indicating whether argument it to be called by value.
[in]_addressIdxIf an address index is specified, not the argument itself but a pointer to this address within the memory of the argument is passed.

Definition at line 55 of file export_argument.cpp.

ExportArgument::ExportArgument ( const std::string &  _name,
const DMatrixPtr _data,
ExportType  _type = REAL,
ExportStruct  _dataStruct = ACADO_LOCAL,
bool  _callByValue = false,
const ExportIndex _addressIdx = emptyConstExportIndex,
const std::string &  _prefix = std::string() 
)

Constructor which takes the name and type of the argument. Moreover, it initializes the argument with the dimensions and the values of the given matrix.

Parameters:
[in]_nameName of the argument.
[in]_dataDMatrix used for initialization.
[in]_typeData type of the argument.
[in]_dataStructGlobal data struct to which the argument belongs to (if any).
[in]_callByValueFlag indicating whether argument it to be called by value.
[in]_addressIdxIf an address index is specified, not the argument itself but a pointer to this address within the memory of the argument is passed.

Definition at line 73 of file export_argument.cpp.

Definition at line 86 of file export_argument.cpp.


Member Function Documentation

Specifies to call argument by value.

Returns:
SUCCESSFUL_RETURN

Definition at line 149 of file export_argument.cpp.

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

Exports declaration of the argument into given file. Its appearance can can be adjusted by various options.

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

Reimplemented from ExportData.

Definition at line 156 of file export_argument.cpp.

ExportArgument ExportArgument::getAddress ( const ExportIndex _rowIdx,
const ExportIndex _colIdx = emptyConstExportIndex 
) const

Returns a copy of the argument with address index set to given location.

Parameters:
[in]rowIdxRow index of the adress.
[in]colIdxColumn index of the adress.
Returns:
Copy of the argument with address index set to given location

Definition at line 103 of file export_argument.cpp.

const std::string ExportArgument::getAddressString ( bool  withDataStruct = true) const

Returns a string containing the address of the argument to be called. If an address index has been set, the string contains a pointer to the desired location. The string also depends on whether the argument is to be called by value or not.

Returns:
String containing the address of the argument

Definition at line 110 of file export_argument.cpp.

uint ExportArgument::getDim ( ) const [virtual]

Returns total dimension of the argument.

Returns:
Total dimension of the argument

Reimplemented in ExportVariable.

Definition at line 129 of file export_argument.cpp.

uint ExportArgument::getNumCols ( ) const [virtual]

Returns number of columns of the argument.

Returns:
Number of columns of the argument

Reimplemented in ExportVariable.

Definition at line 123 of file export_argument.cpp.

uint ExportArgument::getNumRows ( ) const [virtual]

Returns number of rows of the argument.

Returns:
Number of rows of the argument

Reimplemented in ExportVariable.

Definition at line 117 of file export_argument.cpp.

Returns whether argument is to be called by value.

Returns:
true iff argument is to be called by value,
false otherwise

Definition at line 143 of file export_argument.cpp.

bool ExportArgument::isGiven ( ) const [virtual]

Returns whether all components of the argument are given.

Returns:
true iff all components of the argument have given values,
false otherwise

Reimplemented in ExportVariable.

Definition at line 136 of file export_argument.cpp.

ExportArgumentInternal * ExportArgument::operator-> ( )

An operator for access to functions and members of the node

Reimplemented from ExportData.

Reimplemented in ExportVariable.

Definition at line 93 of file export_argument.cpp.

const ExportArgumentInternal * ExportArgument::operator-> ( ) const

An operator for const access to functions and members of the node

Reimplemented from ExportData.

Reimplemented in ExportVariable.

Definition at line 98 of file export_argument.cpp.


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