export_function_call.hpp
Go to the documentation of this file.
1 /*
2  * This file is part of ACADO Toolkit.
3  *
4  * ACADO Toolkit -- A Toolkit for Automatic Control and Dynamic Optimization.
5  * Copyright (C) 2008-2014 by Boris Houska, Hans Joachim Ferreau,
6  * Milan Vukov, Rien Quirynen, KU Leuven.
7  * Developed within the Optimization in Engineering Center (OPTEC)
8  * under supervision of Moritz Diehl. All rights reserved.
9  *
10  * ACADO Toolkit is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU Lesser General Public
12  * License as published by the Free Software Foundation; either
13  * version 3 of the License, or (at your option) any later version.
14  *
15  * ACADO Toolkit is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18  * Lesser General Public License for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public
21  * License along with ACADO Toolkit; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23  *
24  */
25 
26 
27 
35 #ifndef ACADO_TOOLKIT_EXPORT_FUNCTION_CALL_HPP
36 #define ACADO_TOOLKIT_EXPORT_FUNCTION_CALL_HPP
37 
39 
42 
43 
45 
46 
47 
58 {
59  //
60  // PUBLIC MEMBER FUNCTIONS:
61  //
62  public:
63 
78  ExportFunctionCall( const std::string& _name = "acadoFcn",
79  const ExportArgument& _argument1 = emptyConstExportArgument,
80  const ExportArgument& _argument2 = emptyConstExportArgument,
81  const ExportArgument& _argument3 = emptyConstExportArgument,
82  const ExportArgument& _argument4 = emptyConstExportArgument,
83  const ExportArgument& _argument5 = emptyConstExportArgument,
84  const ExportArgument& _argument6 = emptyConstExportArgument,
85  const ExportArgument& _argument7 = emptyConstExportArgument,
86  const ExportArgument& _argument8 = emptyConstExportArgument,
87  const ExportArgument& _argument9 = emptyConstExportArgument
88  );
89 
105  const ExportArgument& _argument1 = emptyConstExportArgument,
106  const ExportArgument& _argument2 = emptyConstExportArgument,
107  const ExportArgument& _argument3 = emptyConstExportArgument,
108  const ExportArgument& _argument4 = emptyConstExportArgument,
109  const ExportArgument& _argument5 = emptyConstExportArgument,
110  const ExportArgument& _argument6 = emptyConstExportArgument,
111  const ExportArgument& _argument7 = emptyConstExportArgument,
112  const ExportArgument& _argument8 = emptyConstExportArgument,
113  const ExportArgument& _argument9 = emptyConstExportArgument
114  );
115 
121  );
122 
125  virtual ~ExportFunctionCall( );
126 
132  );
133 
138  virtual ExportStatement* clone( ) const;
139 
140 
156  returnValue init( const std::string& _name = "defaultFunctionName",
157  const ExportArgument& _argument1 = emptyConstExportArgument,
158  const ExportArgument& _argument2 = emptyConstExportArgument,
159  const ExportArgument& _argument3 = emptyConstExportArgument,
160  const ExportArgument& _argument4 = emptyConstExportArgument,
161  const ExportArgument& _argument5 = emptyConstExportArgument,
162  const ExportArgument& _argument6 = emptyConstExportArgument,
163  const ExportArgument& _argument7 = emptyConstExportArgument,
164  const ExportArgument& _argument8 = emptyConstExportArgument,
165  const ExportArgument& _argument9 = emptyConstExportArgument
166  );
167 
184  returnValue init( const ExportFunction& _f,
185  const ExportArgument& _argument1 = emptyConstExportArgument,
186  const ExportArgument& _argument2 = emptyConstExportArgument,
187  const ExportArgument& _argument3 = emptyConstExportArgument,
188  const ExportArgument& _argument4 = emptyConstExportArgument,
189  const ExportArgument& _argument5 = emptyConstExportArgument,
190  const ExportArgument& _argument6 = emptyConstExportArgument,
191  const ExportArgument& _argument7 = emptyConstExportArgument,
192  const ExportArgument& _argument8 = emptyConstExportArgument,
193  const ExportArgument& _argument9 = emptyConstExportArgument
194  );
195 
196 
208  virtual returnValue exportCode( std::ostream& stream,
209  const std::string& _realString = "real_t",
210  const std::string& _intString = "int",
211  int _precision = 16
212  ) const;
213 
214 
215  //
216  // PROTECTED MEMBER FUNCTIONS:
217  //
218  protected:
219 
224  returnValue clear( );
225 
226 
233  returnValue setName( const std::string& _name
234  );
235 
236 
237  protected:
238 
239  std::string name;
241 };
242 
243 
245 
246 
247 #endif // ACADO_TOOLKIT_EXPORT_STATEMENT_HPP
248 
249 // end of file.
returnValue setName(const std::string &_name)
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 & operator=(const ExportFunctionCall &arg)
Allows to pass back messages to the calling function.
#define CLOSE_NAMESPACE_ACADO
ExportArgumentList functionArguments
Defines a matrix-valued variable that can be passed as argument to exported functions.
virtual ExportStatement * clone() const
Allows to store a list of calling arguments of an ExportFunction.
Allows to export code of a function call.
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)
Base class for all kind of statements to be exported by the code generation tool. ...
Allows to export code of an arbitrary function.
virtual returnValue exportCode(std::ostream &stream, const std::string &_realString="real_t", const std::string &_intString="int", int _precision=16) const
static const ExportArgument emptyConstExportArgument
#define BEGIN_NAMESPACE_ACADO


acado
Author(s): Milan Vukov, Rien Quirynen
autogenerated on Mon Jun 10 2019 12:34:33