export_acado_function.hpp
Go to the documentation of this file.
00001 /*
00002  *    This file is part of ACADO Toolkit.
00003  *
00004  *    ACADO Toolkit -- A Toolkit for Automatic Control and Dynamic Optimization.
00005  *    Copyright (C) 2008-2014 by Boris Houska, Hans Joachim Ferreau,
00006  *    Milan Vukov, Rien Quirynen, KU Leuven.
00007  *    Developed within the Optimization in Engineering Center (OPTEC)
00008  *    under supervision of Moritz Diehl. All rights reserved.
00009  *
00010  *    ACADO Toolkit is free software; you can redistribute it and/or
00011  *    modify it under the terms of the GNU Lesser General Public
00012  *    License as published by the Free Software Foundation; either
00013  *    version 3 of the License, or (at your option) any later version.
00014  *
00015  *    ACADO Toolkit is distributed in the hope that it will be useful,
00016  *    but WITHOUT ANY WARRANTY; without even the implied warranty of
00017  *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00018  *    Lesser General Public License for more details.
00019  *
00020  *    You should have received a copy of the GNU Lesser General Public
00021  *    License along with ACADO Toolkit; if not, write to the Free Software
00022  *    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
00023  *
00024  */
00025 
00032 #ifndef ACADO_TOOLKIT_EXPORT_ODE_FUNCTION_HPP
00033 #define ACADO_TOOLKIT_EXPORT_ODE_FUNCTION_HPP
00034 
00035 #include <acado/code_generation/export_function.hpp>
00036 
00037 BEGIN_NAMESPACE_ACADO
00038 
00039 class Function;
00040 
00050 class ExportAcadoFunction : public ExportFunction
00051 {
00052 public:
00054         ExportAcadoFunction( );
00055 
00062         ExportAcadoFunction(    const Function& _f,
00063                                                         const std::string& _name = "acadoFcn"
00064                                                         );
00065 
00076         ExportAcadoFunction(    const std::string& _name
00077                                                         );
00078 
00080         virtual ~ExportAcadoFunction( );
00081 
00086         virtual ExportStatement* clone( ) const;
00087 
00100         returnValue init(       const Function& _f,
00101                                                 const std::string& _name = "acadoFcn",
00102                                                 const uint _numX = 0,
00103                                                 const uint _numXA = 0,
00104                                                 const uint _numU = 0,
00105                                                 const uint _numP = 0,
00106                                                 const uint _numDX = 0,
00107                                                 const uint _numOD = 0
00108                                                 );
00109 
00120         virtual returnValue exportDataDeclaration(      std::ostream& stream,
00121                                                                                                 const std::string& _realString = "real_t",
00122                                                                                                 const std::string& _intString = "int",
00123                                                                                                 int _precision = 16
00124                                                                                                 ) const;
00125 
00136         virtual returnValue exportForwardDeclaration(   std::ostream& stream,
00137                                                                                                         const std::string& _realString = "real_t",
00138                                                                                                         const std::string& _intString = "int",
00139                                                                                                         int _precision = 16
00140                                                                                                         ) const;
00141 
00152         virtual returnValue exportCode( std::ostream& stream,
00153                                                                         const std::string& _realString = "real_t",
00154                                                                         const std::string& _intString = "int",
00155                                                                         int _precision = 16
00156                                                                         ) const;
00157 
00163         virtual bool isDefined( ) const;
00164 
00166         unsigned getFunctionDim( void );
00167 
00169         returnValue setGlobalExportVariable(const ExportVariable& var);
00170 
00172         ExportVariable getGlobalExportVariable( ) const;
00173 
00175         bool isExternal() const;
00176 
00177 protected:
00181         unsigned numX;
00184         unsigned numXA;
00187         unsigned numU;
00189         unsigned numP;
00192         unsigned numDX;
00194         unsigned numOD;
00196         std::tr1::shared_ptr< Function > f;
00198         ExportVariable globalVar;
00200         bool external;
00201 };
00202 
00203 CLOSE_NAMESPACE_ACADO
00204 
00205 #endif  // ACADO_TOOLKIT_EXPORT_FUNCTION_HPP


acado
Author(s): Milan Vukov, Rien Quirynen
autogenerated on Thu Aug 27 2015 11:58:09