OSOptionsStruc.h
Go to the documentation of this file.
1 /* $Id: OSOptionsStruc.h 5284 2017-12-08 13:52:50Z stefan $ */
16 #ifndef OSOPTIONSSTRUC_H
17 #define OSOPTIONSSTRUC_H
18 
19 #include <string>
20 
21 
33 {
38  std::string configFile;
39 
43  std::string osilFile;
44 
47  std::string osil;
48 
52  std::string osolFile;
53 
56  std::string osol;
57 
61  std::string osrlFile;
62 
65  std::string osrl;
66 
70  std::string insListFile;
71 
74  std::string insList;
75 
79  std::string serviceLocation;
80 
84  std::string serviceMethod;
85 
90  std::string osplInputFile;
91 
94  std::string osplInput;
95 
99  std::string osplOutputFile;
100 
103  std::string osplOutput;
104 
106  std::string mpsFile;
107 
109  std::string mps;
110 
112  std::string nlFile;
113 
115  std::string nl;
116 
118  std::string datFile;
119 
121  std::string dat;
122 
124  std::string gamsControlFile;
125 
129  std::string solverName;
130 
137  std::string browser;
138 
144 
149  std::string logFile;
150 
157 
159  std::string jobID;
160 
165 
170 
175 
183 
187  bool quit;
188 
190  osOptionsStruc();
191 
193  void resetOptions();
194 };
195 
196 
197 #endif
198 
199 /* end header file */
bool invokeHelp
if this parameter is true we print the contents of the file help.txt and return
std::string nlFile
the name of the file that holds an instance in AMPL nl format
std::string osrl
osrl is the content of the osrlFile
bool writeVersion
if this parameter is true, we print the current version of the OS project
int printLevel
this parameter controls the amount of output to print the higher the number, the more output is gener...
std::string osrlFile
osrlFile is the name of the file where the solver should write the result in OSrL format ...
bool printModel
if this parameter is true, we print the current instance as read from an osil, nl or mps file ...
std::string solverName
the name of the solver to be invoked, e.g.
std::string nl
the string that holds an instance in AMPL nl format
std::string osplInput
osplInput is the content of the osplInputFile
std::string mps
the string that holds an instance in MPS format
std::string configFile
configFile is the name of the file that holds the configuration options if the OSSolverService reads ...
bool quit
if this parameter is true, we quit/exit the program – only used in the interactive shell ...
std::string osilFile
osilFile is the name of the file that holds the model instance in OSiL format
std::string insListFile
name of the file containing the instance in LINDO instruction list format
std::string serviceLocation
serviceLocation is the URL of the remote solver when a local solver is not used
int filePrintLevel
this parameter controls the amount of output to send to the log file (if used) the higher the number...
std::string datFile
the name of the file that holds an instance in GAMS dat format
std::string mpsFile
the name of the file that holds an instance in MPS format
std::string osol
osol is the content of the osolFile
std::string osplOutputFile
name of an output file where the solver should write the result of a knock or kill service request ...
std::string jobID
the JobID
This structure is used to store options for the OSSolverService executable.
std::string insList
insList is the content of the insListFile – THIS IS NOT IMPLEMENTED
void resetOptions()
a method to reset the options to their default values
std::string serviceMethod
the service method the OSSolverService should execute, i.e.
std::string printRowNumberAsString
this parameter contains a string representation (!) of the row number if only a single row (constrain...
std::string osplInputFile
name of an input file with xml in OS Process language format, used for example to knock on a server...
osOptionsStruc()
constructor
std::string osolFile
osolFile is the name of the file that holds the solver options in OSoL format
std::string dat
the string that holds an instance in GAMS dat format
std::string osil
osil is the content of the osilFile
std::string logFile
this optional parameter contains the path to a logfile that can be used as an alternate output stream...
std::string osplOutput
osplOutput is the content of the osplOutputFile
std::string browser
this parameter is a path to the browser on the local machine.
std::string gamsControlFile
the name of the .dat that holds the GAMS control file