This structure is used to store options for the OSSolverService executable. More...
#include <OSOptionsStruc.h>
Public Member Functions | |
| osOptionsStruc () | |
| constructor More... | |
| void | resetOptions () |
| a method to reset the options to their default values More... | |
Public Attributes | |
| std::string | configFile |
| configFile is the name of the file that holds the configuration options if the OSSolverService reads its options from a file rather than command line inputs More... | |
| std::string | osilFile |
| osilFile is the name of the file that holds the model instance in OSiL format More... | |
| std::string | osil |
| osil is the content of the osilFile More... | |
| std::string | osolFile |
| osolFile is the name of the file that holds the solver options in OSoL format More... | |
| std::string | osol |
| osol is the content of the osolFile More... | |
| std::string | osrlFile |
| osrlFile is the name of the file where the solver should write the result in OSrL format More... | |
| std::string | osrl |
| osrl is the content of the osrlFile More... | |
| std::string | insListFile |
| name of the file containing the instance in LINDO instruction list format More... | |
| std::string | insList |
| insList is the content of the insListFile – THIS IS NOT IMPLEMENTED More... | |
| std::string | serviceLocation |
| serviceLocation is the URL of the remote solver when a local solver is not used More... | |
| std::string | serviceMethod |
| the service method the OSSolverService should execute, i.e. More... | |
| std::string | osplInputFile |
| name of an input file with xml in OS Process language format, used for example to knock on a server, for example -osplInput ../data/osplFiles/demo.ospl More... | |
| std::string | osplInput |
| osplInput is the content of the osplInputFile More... | |
| std::string | osplOutputFile |
| name of an output file where the solver should write the result of a knock or kill service request More... | |
| std::string | osplOutput |
| osplOutput is the content of the osplOutputFile More... | |
| std::string | mpsFile |
| the name of the file that holds an instance in MPS format More... | |
| std::string | mps |
| the string that holds an instance in MPS format More... | |
| std::string | nlFile |
| the name of the file that holds an instance in AMPL nl format More... | |
| std::string | nl |
| the string that holds an instance in AMPL nl format More... | |
| std::string | datFile |
| the name of the file that holds an instance in GAMS dat format More... | |
| std::string | dat |
| the string that holds an instance in GAMS dat format More... | |
| std::string | gamsControlFile |
| the name of the .dat that holds the GAMS control file More... | |
| std::string | solverName |
| the name of the solver to be invoked, e.g. More... | |
| std::string | browser |
| this parameter is a path to the browser on the local machine. More... | |
| int | printLevel |
| this parameter controls the amount of output to print the higher the number, the more output is generated details about print levels can be found in OSOutput.h More... | |
| std::string | logFile |
| this optional parameter contains the path to a logfile that can be used as an alternate output stream in addition to the normal output to stdout More... | |
| int | filePrintLevel |
| this parameter controls the amount of output to send to the log file (if used) the higher the number, the more output is generated details about print levels can be found in OSOutput.h More... | |
| std::string | jobID |
| the JobID More... | |
| bool | invokeHelp |
| if this parameter is true we print the contents of the file help.txt and return More... | |
| bool | writeVersion |
| if this parameter is true, we print the current version of the OS project More... | |
| bool | printModel |
| if this parameter is true, we print the current instance as read from an osil, nl or mps file More... | |
| std::string | printRowNumberAsString |
| this parameter contains a string representation (!) of the row number if only a single row (constraint or objective) of the current instance is to be printed String representations are easier to parse in OSParseosss.l and are easier to recognize as being present or absent More... | |
| bool | quit |
| if this parameter is true, we quit/exit the program – only used in the interactive shell More... | |
Detailed Description
This structure is used to store options for the OSSolverService executable.
- Remarks
- the OSSolverService requires numerous options and these options are stored in the osOptionsStruc
Definition at line 32 of file OSOptionsStruc.h.
Constructor & Destructor Documentation
| osOptionsStruc::osOptionsStruc | ( | ) |
constructor
OSOptionsStruc is is a data structure to hold OS command line options
Definition at line 26 of file OSOptionsStruc.cpp.
Member Function Documentation
| void osOptionsStruc::resetOptions | ( | ) |
a method to reset the options to their default values
Definition at line 31 of file OSOptionsStruc.cpp.
Member Data Documentation
| std::string osOptionsStruc::configFile |
configFile is the name of the file that holds the configuration options if the OSSolverService reads its options from a file rather than command line inputs
Definition at line 38 of file OSOptionsStruc.h.
| std::string osOptionsStruc::osilFile |
osilFile is the name of the file that holds the model instance in OSiL format
Definition at line 43 of file OSOptionsStruc.h.
| std::string osOptionsStruc::osil |
osil is the content of the osilFile
Definition at line 47 of file OSOptionsStruc.h.
| std::string osOptionsStruc::osolFile |
osolFile is the name of the file that holds the solver options in OSoL format
Definition at line 52 of file OSOptionsStruc.h.
| std::string osOptionsStruc::osol |
osol is the content of the osolFile
Definition at line 56 of file OSOptionsStruc.h.
| std::string osOptionsStruc::osrlFile |
osrlFile is the name of the file where the solver should write the result in OSrL format
Definition at line 61 of file OSOptionsStruc.h.
| std::string osOptionsStruc::osrl |
osrl is the content of the osrlFile
Definition at line 65 of file OSOptionsStruc.h.
| std::string osOptionsStruc::insListFile |
name of the file containing the instance in LINDO instruction list format
Definition at line 70 of file OSOptionsStruc.h.
| std::string osOptionsStruc::insList |
insList is the content of the insListFile – THIS IS NOT IMPLEMENTED
Definition at line 74 of file OSOptionsStruc.h.
| std::string osOptionsStruc::serviceLocation |
serviceLocation is the URL of the remote solver when a local solver is not used
Definition at line 79 of file OSOptionsStruc.h.
| std::string osOptionsStruc::serviceMethod |
the service method the OSSolverService should execute, i.e.
solve, send, getJobID, kill, knock, or retrieve
Definition at line 84 of file OSOptionsStruc.h.
| std::string osOptionsStruc::osplInputFile |
name of an input file with xml in OS Process language format, used for example to knock on a server, for example -osplInput ../data/osplFiles/demo.ospl
Definition at line 90 of file OSOptionsStruc.h.
| std::string osOptionsStruc::osplInput |
osplInput is the content of the osplInputFile
Definition at line 94 of file OSOptionsStruc.h.
| std::string osOptionsStruc::osplOutputFile |
name of an output file where the solver should write the result of a knock or kill service request
Definition at line 99 of file OSOptionsStruc.h.
| std::string osOptionsStruc::osplOutput |
osplOutput is the content of the osplOutputFile
Definition at line 103 of file OSOptionsStruc.h.
| std::string osOptionsStruc::mpsFile |
the name of the file that holds an instance in MPS format
Definition at line 106 of file OSOptionsStruc.h.
| std::string osOptionsStruc::mps |
the string that holds an instance in MPS format
Definition at line 109 of file OSOptionsStruc.h.
| std::string osOptionsStruc::nlFile |
the name of the file that holds an instance in AMPL nl format
Definition at line 112 of file OSOptionsStruc.h.
| std::string osOptionsStruc::nl |
the string that holds an instance in AMPL nl format
Definition at line 115 of file OSOptionsStruc.h.
| std::string osOptionsStruc::datFile |
the name of the file that holds an instance in GAMS dat format
Definition at line 118 of file OSOptionsStruc.h.
| std::string osOptionsStruc::dat |
the string that holds an instance in GAMS dat format
Definition at line 121 of file OSOptionsStruc.h.
| std::string osOptionsStruc::gamsControlFile |
the name of the .dat that holds the GAMS control file
Definition at line 124 of file OSOptionsStruc.h.
| std::string osOptionsStruc::solverName |
the name of the solver to be invoked, e.g.
-solver Ipopt
Definition at line 129 of file OSOptionsStruc.h.
| std::string osOptionsStruc::browser |
this parameter is a path to the browser on the local machine.
If this optional parameter is specified then the solver result in OSrL format is transformed using XSLT into HTML and displayed in the browser, e.g. -browser /Applications/Firefox.app/Contents/MacOS/firefox
Definition at line 137 of file OSOptionsStruc.h.
| int osOptionsStruc::printLevel |
this parameter controls the amount of output to print the higher the number, the more output is generated details about print levels can be found in OSOutput.h
Definition at line 143 of file OSOptionsStruc.h.
| std::string osOptionsStruc::logFile |
this optional parameter contains the path to a logfile that can be used as an alternate output stream in addition to the normal output to stdout
Definition at line 149 of file OSOptionsStruc.h.
| int osOptionsStruc::filePrintLevel |
this parameter controls the amount of output to send to the log file (if used) the higher the number, the more output is generated details about print levels can be found in OSOutput.h
Definition at line 156 of file OSOptionsStruc.h.
| std::string osOptionsStruc::jobID |
the JobID
Definition at line 159 of file OSOptionsStruc.h.
| bool osOptionsStruc::invokeHelp |
if this parameter is true we print the contents of the file help.txt and return
Definition at line 164 of file OSOptionsStruc.h.
| bool osOptionsStruc::writeVersion |
if this parameter is true, we print the current version of the OS project
Definition at line 169 of file OSOptionsStruc.h.
| bool osOptionsStruc::printModel |
if this parameter is true, we print the current instance as read from an osil, nl or mps file
Definition at line 174 of file OSOptionsStruc.h.
| std::string osOptionsStruc::printRowNumberAsString |
this parameter contains a string representation (!) of the row number if only a single row (constraint or objective) of the current instance is to be printed String representations are easier to parse in OSParseosss.l and are easier to recognize as being present or absent
Definition at line 182 of file OSOptionsStruc.h.
| bool osOptionsStruc::quit |
if this parameter is true, we quit/exit the program – only used in the interactive shell
Definition at line 187 of file OSOptionsStruc.h.
The documentation for this struct was generated from the following files:
- /tmp/OS-2.10.2/OS/src/OSParsers/OSOptionsStruc.h
- /tmp/OS-2.10.2/OS/src/OSParsers/OSOptionsStruc.cpp
