osOptionsStruc Struct Reference

This structure is used to store options for the OSSolverService executable. More...

#include <OSOptionsStruc.h>

Collaboration diagram for osOptionsStruc:

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
std::string	osilFile
	osilFile is the name of the file that holds the model instance in OSiL format
std::string	osil
	osil is the flag that tells OSSolverService that the next input is the instance in OSiL format e.g.
std::string	osolFile
	osolFile is the name of the file that holds the solver options
std::string	osol
	osil is the flag that tells OSSolverService that the next input is a file with solver options e.g.
std::string	osrlFile
	osrlFile is the name of the file where the solver should write the result in OSrL format
std::string	osrl
	osrl is the flag that tells OSSolverService that the next input is the file name wher the solver should write the result e.g.
std::string	insListFile
	name of the file where the instance is in a LINDO instruction list format
std::string	insList
	osrl is the flag that tells OSSolverService that the next input is the file name wher the instance is a LINDO instruction list -- this is not implemented
std::string	serviceLocation
	serviceLocation is the URL of the remote solver when a local solver is not use
std::string	serviceMethod
	the service method the OSSolverService should execute, e.g solve, send, getJobID, kill, knock, or retrieve
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 .
std::string	osplOutputFile
	name of an output file where the solver should write the result of a knock or kill service request
std::string	osplInput
	osplInput is the flag that tells OSSolverService that the next input is the file name of the file holding the OSpL that the OSSolverService sends to the solver e.g.
std::string	osplOutput
	osplOutput is the flag that tells OSSolverService that the next input is the file name of the file holding the OSpL that the solver should write to e.g.
std::string	mpsFile
	the name of the mpsFile that holds an instance in mps format
std::string	nlFile
	the name of the nlFile that holds an instance in AMPL nl format
std::string	solverName
	the name of the solver to be invoked, e.g -solver Ipopt
std::string	browser
	this paramater is a path to the browser on the local machine.
bool	invokeHelp
	if this parameter is true we print the contents of the file help.txt and return
bool	writeVersion
	if this parameter is true we print the current version of the OS project

Detailed Description

This structure is used to store options for the OSSolverService executable.

Author:: Robert Fourer, Jun Ma, Kipp Martin

Version:: 1.0, 03/14/2004

Since:: OS 1.0

Remarks:: the OSSolverService requires numerous options and these options are stored in the osOptionsStruc

Definition at line 33 of file OSOptionsStruc.h.

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 flag that tells OSSolverService that the next input is the instance in OSiL format e.g.

-osil ../data/osilFiles/wayneQuadratic.osil

Definition at line 49 of file OSOptionsStruc.h.

std::string osOptionsStruc::osolFile

osolFile is the name of the file that holds the solver options

Definition at line 53 of file OSOptionsStruc.h.

std::string osOptionsStruc::osol

osil is the flag that tells OSSolverService that the next input is a file with solver options e.g.

-osol ../data/osolFiles/demo.osol

Definition at line 59 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 64 of file OSOptionsStruc.h.

std::string osOptionsStruc::osrl

osrl is the flag that tells OSSolverService that the next input is the file name wher the solver should write the result e.g.

-osrl ../data/osrlFiles/test.osrl

Definition at line 70 of file OSOptionsStruc.h.

std::string osOptionsStruc::insListFile

name of the file where the instance is in a LINDO instruction list format

Definition at line 75 of file OSOptionsStruc.h.

std::string osOptionsStruc::insList

osrl is the flag that tells OSSolverService that the next input is the file name wher the instance is a LINDO instruction list -- this is not implemented

Definition at line 81 of file OSOptionsStruc.h.

std::string osOptionsStruc::serviceLocation

serviceLocation is the URL of the remote solver when a local solver is not use

Definition at line 86 of file OSOptionsStruc.h.

std::string osOptionsStruc::serviceMethod

the service method the OSSolverService should execute, e.g solve, send, getJobID, kill, knock, or retrieve

Definition at line 91 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 97 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 103 of file OSOptionsStruc.h.

std::string osOptionsStruc::osplInput

osplInput is the flag that tells OSSolverService that the next input is the file name of the file holding the OSpL that the OSSolverService sends to the solver e.g.

-osplInput ../data/osplFiles/demo.ospl

Definition at line 110 of file OSOptionsStruc.h.

std::string osOptionsStruc::osplOutput

osplOutput is the flag that tells OSSolverService that the next input is the file name of the file holding the OSpL that the solver should write to e.g.

-osplOutput ../data/osplFiles/test.ospl

Definition at line 117 of file OSOptionsStruc.h.

std::string osOptionsStruc::mpsFile

the name of the mpsFile that holds an instance in mps format

Definition at line 120 of file OSOptionsStruc.h.

std::string osOptionsStruc::nlFile

the name of the nlFile that holds an instance in AMPL nl format

Definition at line 123 of file OSOptionsStruc.h.

std::string osOptionsStruc::solverName

the name of the solver to be invoked, e.g -solver Ipopt

Definition at line 128 of file OSOptionsStruc.h.

std::string osOptionsStruc::browser

this paramater 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 136 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 141 of file OSOptionsStruc.h.

bool osOptionsStruc::writeVersion

if this parameter is true we print the current version of the OS project

Definition at line 146 of file OSOptionsStruc.h.

The documentation for this struct was generated from the following file:

/home/coin/svn-release/OptimizationSuite-1.1.0/OS/src/OSParsers/OSOptionsStruc.h

osOptionsStruc Struct Reference

Public Attributes

Detailed Description

Member Data Documentation