export_data.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 
00026 
00027 
00034 #ifndef ACADO_TOOLKIT_EXPORT_DATA_HPP
00035 #define ACADO_TOOLKIT_EXPORT_DATA_HPP
00036 
00037 #include <acado/utils/acado_utils.hpp>
00038 #include <casadi/symbolic/shared_object.hpp>
00039 
00040 BEGIN_NAMESPACE_ACADO
00041 
00042 // Forward declaration
00043 class ExportDataInternal;
00044 
00055 class ExportData : public CasADi::SharedObject
00056 {
00057     //
00058     // PUBLIC MEMBER FUNCTIONS:
00059     //
00060     public:
00063         ExportData( );
00064 
00067         virtual ~ExportData( );
00068 
00071         ExportDataInternal* operator->();
00072 
00075         const ExportDataInternal* operator->() const;
00076 
00083                 returnValue     setName(        const std::string& _name
00084                                                                 );
00085 
00092                 returnValue     setType(        ExportType _type
00093                                                                 );
00094                                                                 
00101                 returnValue     setDataStruct(  ExportStruct _dataStruct
00102                                                                         );
00109                 returnValue setPrefix(  const std::string& _prefix
00110                                                                 );
00115                 std::string getName( ) const;
00116 
00121                 ExportType getType( ) const;
00122 
00130                 std::string getTypeString(      const std::string& _realString = "real_t",
00131                                                                         const std::string& _intString = "int"
00132                                                                         ) const;
00133 
00138                 ExportStruct getDataStruct( ) const;
00139 
00144                 std::string getDataStructString( ) const;
00145                 
00150                 std::string getPrefix( ) const;
00151 
00157                 std::string getFullName( ) const;
00158 
00159 
00170                 virtual returnValue exportDataDeclaration(      std::ostream& stream,
00171                                                                                                         const std::string& _realString = "real_t",
00172                                                                                                         const std::string& _intString = "int",
00173                                                                                                         int _precision = 16
00174                                                                                                         ) const;
00175 
00176 
00182                 virtual bool isGiven( );
00183 
00184                 virtual returnValue setDoc(const std::string& _doc);
00185 
00186                 virtual std::string getDoc() const;
00187 };
00188 
00189 CLOSE_NAMESPACE_ACADO
00190 
00191 
00192 #endif  // ACADO_TOOLKIT_EXPORT_DATA_HPP
00193 
00194 // end of file.


acado
Author(s): Milan Vukov, Rien Quirynen
autogenerated on Sat Jun 8 2019 19:37:01