IpIpoptApplication.hpp
Go to the documentation of this file.
1 // Copyright (C) 2004, 2010 International Business Machines and others.
2 // All Rights Reserved.
3 // This code is published under the Eclipse Public License.
4 //
5 // $Id: IpIpoptApplication.hpp 1861 2010-12-21 21:34:47Z andreasw $
6 //
7 // Authors: Carl Laird, Andreas Waechter IBM 2004-08-13
8 
9 #ifndef __IPIPOPTAPPLICATION_HPP__
10 #define __IPIPOPTAPPLICATION_HPP__
11 
12 #ifndef IPOPT_EXPORT
13 #ifdef _MSC_VER
14 #ifdef IPOPT_DLL
15 #define IPOPT_EXPORT(type) __declspec(dllexport) type __cdecl
16 #else
17 #define IPOPT_EXPORT(type) type __cdecl
18 #endif
19 #else
20 #define IPOPT_EXPORT(type) type
21 #endif
22 #endif
23 
24 #include <iostream>
25 
26 #include "IpJournalist.hpp"
27 #include "IpTNLP.hpp"
28 #include "IpNLP.hpp"
29 /* Return codes for the Optimize call for an application */
30 #include "IpReturnCodes.hpp"
31 
32 namespace Ipopt
33 {
34  DECLARE_STD_EXCEPTION(IPOPT_APPLICATION_ERROR);
35 
36  /* forward declarations */
37  class IpoptAlgorithm;
38  class IpoptNLP;
39  class IpoptData;
40  class IpoptCalculatedQuantities;
41  class AlgorithmBuilder;
42  class RegisteredOptions;
43  class OptionsList;
44  class SolveStatistics;
45 
48  {
49  public:
50  IpoptApplication(bool create_console_out = true,
51  bool create_empty = false);
52 
56  SmartPtr<OptionsList> options,
57  SmartPtr<Journalist> jnlst);
58 
59  virtual ~IpoptApplication();
60 
65 
73  virtual ApplicationReturnStatus Initialize(std::string params_file = "ipopt.opt");
74  virtual ApplicationReturnStatus Initialize(std::istream& is);
75 
80 
83 
86 
93 
101 
104  virtual bool OpenOutputFile(std::string file_name, EJournalLevel print_level);
105 
110  {
111  return jnlst_;
112  }
113 
117  {
118  return reg_options_;
119  }
120 
123  {
124  return options_;
125  }
126 
129  {
130  return ConstPtr(options_);
131  }
132 
136 
139 
142 
145 
149 
154  void PrintCopyrightMessage();
155 
158  static void RegisterOptions(SmartPtr<RegisteredOptions> roptions);
160 
162  static void
164 
165  private:
175  // IpoptApplication();
176 
179 
181  void operator=(const IpoptApplication&);
183 
187 
193 
196 
199 
202 
206 
210 
214 
219 
224 
228 
240  };
241 
242 } // namespace Ipopt
243 
244 extern "C" IPOPT_EXPORT(class Ipopt::IpoptApplication *) IpoptApplicationFactory();
245 
246 #endif