OS  2.10.2
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 
219 
222 
227 
230  std::string list_options();
231 
236 
240 };
241 
242 #endif
243 
244 /* end header file */
OSCommandLine::osplOutputFile
std::string osplOutputFile
name of an output file where the solver should write the result of a knock or kill service request
Definition: OSCommandLine.h:131
OSCommandLine::~OSCommandLine
~OSCommandLine()
destructor method
OSCommandLine::nl
std::string nl
the string that holds an instance in AMPL nl format
Definition: OSCommandLine.h:143
OSCommandLine::osolOutputFile
std::string osolOutputFile
osolOutputFile is the name of the file to which the solver options can be written in OSoL format.
Definition: OSCommandLine.h:101
OSCommandLine::gamsControlFile
std::string gamsControlFile
the name of the file that holds the GAMS control parameters
Definition: OSCommandLine.h:152
OSCommandLine::mps
std::string mps
the string that holds an instance in MPS format
Definition: OSCommandLine.h:137
OSCommandLine::solverName
std::string solverName
the name of the solver to be invoked locally, e.g -solver Ipopt
Definition: OSCommandLine.h:62
OSCommandLine::configFile
std::string configFile
configFile is the name of the file that holds the configuration options if the OSSolverService reads ...
Definition: OSCommandLine.h:68
OSInstance
The in-memory representation of an OSiL instance..
Definition: OSInstance.h:2263
OSCommandLine::datFile
std::string datFile
the name of the file that holds an instance in GAMS dat format
Definition: OSCommandLine.h:146
OSCommandLine
This class is used to store command line options for the OSSolverService executable and to provide me...
Definition: OSCommandLine.h:37
OSCommandLine::writeVersion
bool writeVersion
if this parameter is true we print the current version of the OS project
Definition: OSCommandLine.h:197
OSCommandLine::jobID
std::string jobID
the JobID
Definition: OSCommandLine.h:182
OSInstance.h
This file defines the OSInstance class along with its supporting classes.
OSOption.h
OSCommandLine::osil
std::string osil
osil is the content of the osilFile
Definition: OSCommandLine.h:77
OSCommandLine::serviceMethod
std::string serviceMethod
the service method the OSSolverService should execute, i.e.
Definition: OSCommandLine.h:57
OSCommandLine::nlFile
std::string nlFile
the name of the file that holds an instance in AMPL nl format
Definition: OSCommandLine.h:140
OSCommandLine::osinstance
OSInstance * osinstance
osinstance is a representation of the instance in OSInstance format
Definition: OSCommandLine.h:42
OSCommandLine::dat
std::string dat
the string that holds an instance in GAMS dat format
Definition: OSCommandLine.h:149
OSCommandLine::printLevel
int printLevel
this parameter controls the amount of output to print the higher the number, the more output is gener...
Definition: OSCommandLine.h:166
OSCommandLine::invokeHelp
bool invokeHelp
if this parameter is true we print the contents of the file help.txt and return
Definition: OSCommandLine.h:187
OSCommandLine::osilFile
std::string osilFile
osilFile is the name of the file that holds the model instance in OSiL format
Definition: OSCommandLine.h:73
OSCommandLine::osolFile
std::string osolFile
osolFile is the name of the file that holds the solver options in OSoL format
Definition: OSCommandLine.h:89
OSCommandLine::OSCommandLine
OSCommandLine()
constructor method
OSCommandLine::printRowNumberAsString
std::string printRowNumberAsString
this parameter contains a string representation (!) of the row number if only a single row (constrain...
Definition: OSCommandLine.h:210
OSCommandLine::browser
std::string browser
this parameter is a path to the browser on the local machine.
Definition: OSCommandLine.h:160
OSCommandLine::reset_options
void reset_options()
a function to reset the command line to default values useful especially in the interactive shell
OSCommandLine::printModel
bool printModel
if this parameter is true we print the current instance as read from an osil, nl or mps file
Definition: OSCommandLine.h:202
OSCommandLine::filePrintLevel
int filePrintLevel
this parameter controls the amount of output to send to the log file (if used) the higher the number,...
Definition: OSCommandLine.h:179
OSCommandLine::convertSolverNameToLowerCase
void convertSolverNameToLowerCase()
to avoid ambiguity it might be necessary to convert the solver name to lower case ....
OSOption
The Option Class.
Definition: OSOption.h:3565
OSCommandLine::insList
std::string insList
insList is the content of the insListFile – this is not implemented
Definition: OSCommandLine.h:115
OSCommandLine::osoption
OSOption * osoption
osoption is a representation of the solver options in OSOption format
Definition: OSCommandLine.h:47
OSCommandLine::quit
bool quit
if this parameter is true we quit/exit
Definition: OSCommandLine.h:215
OSCommandLine::serviceLocation
std::string serviceLocation
serviceLocation is the URL of the remote solver when a local solver is not used
Definition: OSCommandLine.h:52
OSCommandLine::convertSolverNameToUpperCase
void convertSolverNameToUpperCase()
...
OSCommandLine::mpsFile
std::string mpsFile
the name of the file that holds an instance in MPS format
Definition: OSCommandLine.h:134
OSCommandLine::logFile
std::string logFile
this optional parameter contains the path to a logfile that can be used as an alternate output stream...
Definition: OSCommandLine.h:172
OSCommandLine::list_options
std::string list_options()
a function to print the current command line option values
OSCommandLine::osilOutputFile
std::string osilOutputFile
osilOutputFile is the name of the file to which the instance can be written in OSiL format.
Definition: OSCommandLine.h:84
OSCommandLine::osplInput
std::string osplInput
osplInput is the content of the osplInputFile
Definition: OSCommandLine.h:125
OSCommandLine::insListFile
std::string insListFile
name of the file containing the instance in LINDO instruction list format
Definition: OSCommandLine.h:111
OSCommandLine::osol
std::string osol
osol is the content of the osolFile
Definition: OSCommandLine.h:93
OSCommandLine::listOptions
bool listOptions
if this parameter is true we echo the values of the options found on the command line
Definition: OSCommandLine.h:192
OSCommandLine::osplInputFile
std::string osplInputFile
name of an input file with xml in OS process language format, used for example to knock on a server,...
Definition: OSCommandLine.h:121
OSCommandLine::osrlFile
std::string osrlFile
osrlFile is the name of the file where the solver should write the result (in OSrL format)
Definition: OSCommandLine.h:106