export_data.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 
34 #ifndef ACADO_TOOLKIT_EXPORT_DATA_HPP
35 #define ACADO_TOOLKIT_EXPORT_DATA_HPP
36 
39 
41 
42 // Forward declaration
43 class ExportDataInternal;
44 
56 {
57  //
58  // PUBLIC MEMBER FUNCTIONS:
59  //
60  public:
63  ExportData( );
64 
67  virtual ~ExportData( );
68 
72 
75  const ExportDataInternal* operator->() const;
76 
83  returnValue setName( const std::string& _name
84  );
85 
93  );
94 
102  );
109  returnValue setPrefix( const std::string& _prefix
110  );
115  std::string getName( ) const;
116 
121  ExportType getType( ) const;
122 
130  std::string getTypeString( const std::string& _realString = "real_t",
131  const std::string& _intString = "int"
132  ) const;
133 
138  ExportStruct getDataStruct( ) const;
139 
144  std::string getDataStructString( ) const;
145 
150  std::string getPrefix( ) const;
151 
157  std::string getFullName( ) const;
158 
159 
170  virtual returnValue exportDataDeclaration( std::ostream& stream,
171  const std::string& _realString = "real_t",
172  const std::string& _intString = "int",
173  int _precision = 16
174  ) const;
175 
176 
182  virtual bool isGiven( );
183 
184  virtual returnValue setDoc(const std::string& _doc);
185 
186  virtual std::string getDoc() const;
187 };
188 
190 
191 
192 #endif // ACADO_TOOLKIT_EXPORT_DATA_HPP
193 
194 // end of file.
virtual ~ExportData()
Definition: export_data.cpp:48
Allows to pass back messages to the calling function.
returnValue setName(const std::string &_name)
Definition: export_data.cpp:61
#define CLOSE_NAMESPACE_ACADO
std::string getPrefix() const
Definition: export_data.cpp:96
virtual returnValue exportDataDeclaration(std::ostream &stream, const std::string &_realString="real_t", const std::string &_intString="int", int _precision=16) const
std::string getTypeString(const std::string &_realString="real_t", const std::string &_intString="int") const
virtual returnValue setDoc(const std::string &_doc)
SharedObject implements a reference counting framework simular for effient and easily-maintained memo...
returnValue setPrefix(const std::string &_prefix)
Definition: export_data.cpp:74
virtual std::string getDoc() const
ExportStruct
ExportStruct getDataStruct() const
returnValue setType(ExportType _type)
Definition: export_data.cpp:68
ExportType
returnValue setDataStruct(ExportStruct _dataStruct)
Definition: export_data.cpp:80
std::string getFullName() const
ExportDataInternal * operator->()
Definition: export_data.cpp:51
virtual bool isGiven()
#define BEGIN_NAMESPACE_ACADO
Abstract base class to define variables to be used for exporting code.
Definition: export_data.hpp:55
ExportType getType() const
Definition: export_data.cpp:91
std::string getDataStructString() const
std::string getName() const
Definition: export_data.cpp:86


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