OS  2.9.3
OSCommandLine.h
Go to the documentation of this file.
1 /* $Id: OSCommandLine.h 4403 2011-12-08 14:03:28Z Gassmann $ */
16 #ifndef OSCOMMANDLINE_H
17 #define OSCOMMANDLINE_H
18 
19 #include "OSInstance.h"
20 #include "OSOption.h"
21 
22 #include <string>
23 
24 
37 {
38 public:
43 
48 
52  std::string serviceLocation;
53 
57  std::string serviceMethod;
58 
62  std::string solverName;
63 
68  std::string configFile;
69 
73  std::string osilFile;
74 
77  std::string osil;
78 
84  std::string osilOutputFile;
85 
89  std::string osolFile;
90 
93  std::string osol;
94 
101  std::string osolOutputFile;
102 
106  std::string osrlFile;
107 
111  std::string insListFile;
112 
115  std::string insList;
116 
121  std::string osplInputFile;
122 
125  std::string osplInput;
126 
131  std::string osplOutputFile;
132 
134  std::string mpsFile;
135 
137  std::string mps;
138 
140  std::string nlFile;
141 
143  std::string nl;
144 
146  std::string datFile;
147 
149  std::string dat;
150 
152  std::string gamsControlFile;
153 
160  std::string browser;
161 
167 
172  std::string logFile;
173 
180 
182  std::string jobID;
183 
188 
193 
198 
203 
211 
215  bool quit;
216 
218  OSCommandLine();
219 
221  ~OSCommandLine();
222 
226  void reset_options();
227 
230  std::string list_options();
231 
236 
240 };
241 
242 #endif
243 
244 /* end header file */
std::string list_options()
a function to print the current command line option values
std::string jobID
the JobID
OSInstance * osinstance
osinstance is a representation of the instance in OSInstance format
Definition: OSCommandLine.h:42
std::string osil
osil is the content of the osilFile
Definition: OSCommandLine.h:77
std::string configFile
configFile is the name of the file that holds the configuration options if the OSSolverService reads ...
Definition: OSCommandLine.h:68
bool printModel
if this parameter is true we print the current instance as read from an osil, nl or mps file ...
std::string insListFile
name of the file containing the instance in LINDO instruction list format
std::string osolFile
osolFile is the name of the file that holds the solver options in OSoL format
Definition: OSCommandLine.h:89
The Option Class.
Definition: OSOption.h:3564
std::string browser
this parameter is a path to the browser on the local machine.
std::string dat
the string that holds an instance in GAMS dat format
std::string mps
the string that holds an instance in MPS format
This class is used to store command line options for the OSSolverService executable and to provide me...
Definition: OSCommandLine.h:36
OSCommandLine()
constructor method
std::string serviceLocation
serviceLocation is the URL of the remote solver when a local solver is not used
Definition: OSCommandLine.h:52
std::string serviceMethod
the service method the OSSolverService should execute, i.e.
Definition: OSCommandLine.h:57
std::string nlFile
the name of the file that holds an instance in AMPL nl format
~OSCommandLine()
destructor method
std::string nl
the string that holds an instance in AMPL nl format
bool writeVersion
if this parameter is true we print the current version of the OS project
std::string osilFile
osilFile is the name of the file that holds the model instance in OSiL format
Definition: OSCommandLine.h:73
int filePrintLevel
this parameter controls the amount of output to send to the log file (if used) the higher the number...
std::string printRowNumberAsString
this parameter contains a string representation (!) of the row number if only a single row (constrain...
std::string osplInput
osplInput is the content of the osplInputFile
std::string solverName
the name of the solver to be invoked locally, e.g -solver Ipopt
Definition: OSCommandLine.h:62
The in-memory representation of an OSiL instance.
Definition: OSInstance.h:2241
std::string datFile
the name of the file that holds an instance in GAMS dat format
bool invokeHelp
if this parameter is true we print the contents of the file help.txt and return
std::string osol
osol is the content of the osolFile
Definition: OSCommandLine.h:93
std::string osilOutputFile
osilOutputFile is the name of the file to which the instance can be written in OSiL format...
Definition: OSCommandLine.h:84
void convertSolverNameToUpperCase()
...
void convertSolverNameToLowerCase()
to avoid ambiguity it might be necessary to convert the solver name to lower case ...
std::string logFile
this optional parameter contains the path to a logfile that can be used as an alternate output stream...
int printLevel
this parameter controls the amount of output to print the higher the number, the more output is gener...
std::string gamsControlFile
the name of the file that holds the GAMS control parameters
std::string osrlFile
osrlFile is the name of the file where the solver should write the result (in OSrL format) ...
std::string osplOutputFile
name of an output file where the solver should write the result of a knock or kill service request ...
std::string mpsFile
the name of the file that holds an instance in MPS format
std::string osplInputFile
name of an input file with xml in OS process language format, used for example to knock on a server...
This file defines the OSInstance class along with its supporting classes.
bool quit
if this parameter is true we quit/exit
std::string osolOutputFile
osolOutputFile is the name of the file to which the solver options can be written in OSoL format...
void reset_options()
a function to reset the command line to default values useful especially in the interactive shell ...
std::string insList
insList is the content of the insListFile – this is not implemented
OSOption * osoption
osoption is a representation of the solver options in OSOption format
Definition: OSCommandLine.h:47
bool listOptions
if this parameter is true we echo the values of the options found on the command line ...