OSOption Class Reference

The Option Class. More...

#include <OSOption.h>

Collaboration diagram for OSOption:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 OSOption ()
 Default constructor.
 ~OSOption ()
 Class destructor.
bool setOptionHeader (std::string name, std::string source, std::string fileCreator, std::string description, std::string licence)
 A function to populate an instance of the option header element.
bool IsEqual (OSOption *that)
 A function to check for the equality of two objects.
bool setRandom (double density, bool conformant)
 A function to make a random instance of this class.
std::string getFileName ()
 Get the name of the file.
std::string getFileSource ()
 Get the source of the file or problem.
std::string getFileDescription ()
 Get a description for the file or problem.
std::string getFileCreator ()
 Get the name of the person who created the file.
std::string getFileLicence ()
 Get licence information associated with the file.
std::string getServiceURI ()
 Get the service URI.
std::string getServiceName ()
 Get the service name.
std::string getInstanceName ()
 Get the instance name.
std::string getInstanceLocation ()
 Get the instance location.
std::string getInstanceLocationType ()
 Get the location type.
std::string getJobID ()
 Get the job ID.
std::string getSolverToInvoke ()
 Get the solver name.
std::string getLicense ()
 Get the license string.
std::string getUserName ()
 Get the user name.
std::string getPassword ()
 Get the password.
std::string getContact ()
 Get the contact information.
std::string getContactTransportType ()
 Get the transport type.
std::string getMinDiskSpaceUnit ()
 Get the disk space unit.
std::string getMinDiskSpaceDescription ()
 get the disk space description
std::string getMinMemoryUnit ()
 Get the memory unit.
std::string getMinMemoryDescription ()
 get the memory description
std::string getMinCPUSpeedUnit ()
 Get the CPU speed unit.
std::string getMinCPUSpeedDescription ()
 Get the CPU speed description.
std::string getMinCPUNumberDescription ()
 Get the CPU description.
std::string getServiceType ()
 Get the service type.
std::string getMaxTimeUnit ()
 Get the time unit.
std::string getRequestedStartTime ()
 Get the requested starting time.
std::string getOptionStr (std::string optionName)
 Get any of the string-valued options.
double getMinDiskSpace ()
 Get the minimum required disk space.
double getMinMemorySize ()
 Get the minimum required memory.
double getMinCPUSpeed ()
 Get the minimum required CPU speed.
double getMaxTime ()
 Get the maximum allowed time.
double getOptionDbl (std::string optionName)
 Get any of the double-valued options.
int getMinCPUNumber ()
 Get the minimum required number of CPUs.
int getNumberOfOtherGeneralOptions ()
 Get the number of <other> options in the <general> element.
int getNumberOfOtherSystemOptions ()
 Get the number of <other> options in the <system> element.
int getNumberOfOtherServiceOptions ()
 Get the number of <other> options in the <service> element.
int getNumberOfOtherJobOptions ()
 Get the number of <other> options in the <job> element.
int getNumberOfJobDependencies ()
 Get the number of job dependencies.
int getNumberOfRequiredDirectories ()
 Get the number of required directories.
int getNumberOfRequiredFiles ()
 Get the number of required files.
int getNumberOfDirectoriesToMake ()
 Get the number of directories to make.
int getNumberOfFilesToMake ()
 Get the number of files to make.
int getNumberOfInputDirectoriesToMove ()
 Get the number of input directories to move.
int getNumberOfInputFilesToMove ()
 Get the number of input files to move.
int getNumberOfOutputDirectoriesToMove ()
 Get the number of output directories to move.
int getNumberOfOutputFilesToMove ()
 Get the number of output files to move.
int getNumberOfFilesToDelete ()
 Get the number of files to delete.
int getNumberOfDirectoriesToDelete ()
 Get the number of directories to delete.
int getNumberOfProcessesToKill ()
 Get the number of processes to kill.
int getNumberOfVariables ()
 Get the number of variables in the instance.
int getNumberOfObjectives ()
 Get the number of objectives in the instance.
int getNumberOfConstraints ()
 Get the number of constraints in the instance.
int getNumberOfInitVarValues ()
 Get the number of initial variable values.
int getNumberOfInitVarValuesString ()
 Get the number of initial variable strings.
int getNumberOfIntegerVariableBranchingWeights ()
 Get the number of variables for which integer branching weights are provided.
int getNumberOfSOS ()
 Get the number of special ordered sets for which branching weights are provided.
int getNumberOfSOSVarBranchingWeights (int iSOS)
 Get the number of variables for which branching weights are provided in a particular SOS.
int getNumberOfOtherVariableOptions ()
 Get the number of other variable options.
int getNumberOfInitObjValues ()
 Get the number of initial objective values.
int getNumberOfInitObjBounds ()
 Get the number of initial objective bounds.
int getNumberOfOtherObjectiveOptions ()
 Get the number of other objective options.
int getNumberOfInitConValues ()
 Get the number of initial constraint values.
int getNumberOfInitDualVarValues ()
 Get the number of initial dual variable values.
int getNumberOfOtherConstraintOptions ()
 Get the number of other constraint options.
int getNumberOfSolverOptions ()
 Get the number of solver options.
int getOptionInt (std::string optionName)
 Get any of the integer-valued options.
OtherOption ** getOtherGeneralOptions ()
 Get the array of other options associated with the <general> element.
OtherOption ** getOtherSystemOptions ()
 Get the array of other options associated with the <system> element.
OtherOption ** getOtherServiceOptions ()
 Get the array of other options associated with the <service> element.
OtherOption ** getOtherJobOptions ()
 Get the array of other options associated with the <job> element.
OtherOption ** getOtherOptions (std::string elementName)
 Get the array of other options associated with any element.
OtherOption ** getAllOtherOptions ()
 Get the array of all other options associated with the <general>, <system>, <service> and <job> elements.
std::string * getJobDependencies ()
 Get the array of job dependencies.
std::string * getRequiredDirectories ()
 Get the array of required directories.
std::string * getRequiredFiles ()
 Get the array of required files.
std::string * getDirectoriesToMake ()
 Get the array of directories to make.
std::string * getFilesToMake ()
 Get the array of files to make.
PathPair ** getInputDirectoriesToMove ()
 Get the array of input directories to move.
PathPair ** getInputFilesToMove ()
 Get the array of input files to move.
PathPair ** getOutputDirectoriesToMove ()
 Get the array of output directories to move.
PathPair ** getOutputFilesToMove ()
 Get the array of output files to move.
std::string * getDirectoriesToDelete ()
 Get the array of directories to delete.
std::string * getFilesToDelete ()
 Get the array of files to delete.
std::string * getProcessesToKill ()
 Get the array of processes to kill.
InitVarValue ** getInitVarValuesSparse ()
 Get the initial values associated with the variables in sparse form.
double * getInitVarValuesDense ()
 Get the initial values associated with the variables in dense form.
double * getInitVarValuesDense (int numberOfVariables)
 Get the initial values associated with the variables in dense form.
InitVarValueString ** getInitVarValuesStringSparse ()
 Get the initial value strings associated with the variables in sparse form.
std::string * getInitVarValuesStringDense ()
 Get the initial value strings associated with the variables in dense form.
std::string * getInitVarValuesStringDense (int numberOfVariables)
 Get the initial value strings associated with the variables in dense form.
InitBasStatus ** getInitBasisStatusSparse ()
 Get the initial basis status in sparse form.
std::string * getInitBasisStatusDense ()
 Get the initial basis information in dense form.
int * getVariableInitialBasisStatusDense (int numberOfVariables)
 Get the initial basis status for all variables in dense form.
int getNumberOfInitialBasisElements (int type, int status)
 Get the number of initial basis elements for a particular variable type and basis status.
bool getInitialBasisElements (int type, int status, int *elem)
 Get the initial basis elements for a particular variable type and basis status.
BranchingWeight ** getIntegerVariableBranchingWeightsSparse ()
 Get the integer branching weights in sparse form.
double * getIntegerVariableBranchingWeightsDense ()
 Get the integer branching weights in dense form.
double * getIntegerVariableBranchingWeightsDense (int numberOfVariables)
 Get the integer branching weights in dense form.
SOSWeights ** getSOSVariableBranchingWeightsSparse ()
 Get the SOS branching weights in sparse form.
std::vector
< OtherVariableOption * > 
getOtherVariableOptions (std::string solver_name)
 Get the <other> variable options associated with a particular solver.
OtherVariableOption ** getAllOtherVariableOptions ()
 Get all <other> variable options.
InitObjValue ** getInitObjValuesSparse ()
 Get the initial values associated with the objectives in sparse form.
double * getInitObjValuesDense ()
 Get the initial values associated with the objectives in dense form.
double * getInitObjValuesDense (int numberOfObjectives)
 Get the initial values associated with the objectives in dense form.
InitObjBound ** getInitObjBoundsSparse ()
 Get the initial bounds associated with the objectives in sparse form.
double * getInitObjLowerBoundsDense ()
 Get the initial lower bounds associated with the objectives in dense form.
double * getInitObjLowerBoundsDense (int numberOfObjectives)
 Get the initial lower bounds associated with the objectives in dense form.
double * getInitObjUpperBoundsDense ()
 Get the initial upper bounds associated with the objectives in dense form.
double * getInitObjUpperBoundsDense (int numberOfObjectives)
 Get the initial upper bounds associated with the objectives in dense form.
int * getObjectiveInitialBasisStatusDense (int numberOfObjectives)
 Get the initial basis status for all objectives in dense form.
std::vector
< OtherObjectiveOption * > 
getOtherObjectiveOptions (std::string solver_name)
 Get the array of other objective options.
OtherObjectiveOption ** getAllOtherObjectiveOptions ()
 Get all <other> objective options.
InitConValue ** getInitConValuesSparse ()
 Get the initial values associated with the constraints in sparse form.
double * getInitConValuesDense ()
 Get the initial values associated with the constraints in dense form.
double * getInitConValuesDense (int numberOfConstraints)
 Get the initial values associated with the constraints in dense form.
InitDualVarValue ** getInitDualVarValuesSparse ()
 Get the initial bounds associated with the dual variables in sparse form.
double * getInitDualVarLowerBoundsDense ()
 Get the initial dual variables associated with the lower bounds in dense form.
double * getInitDualVarLowerBoundsDense (int numberOfConstraints)
 Get the initial dual variables associated with the lower bounds in dense form.
double * getInitDualVarUpperBoundsDense ()
 Get the initial dual variables associated with the upper bounds in dense form.
double * getInitDualVarUpperBoundsDense (int numberOfConstraints)
 Get the initial dual variables associated with the upper bounds in dense form.
int * getSlackVariableInitialBasisStatusDense (int numberOfConstraints)
 Get the initial basis status for all slack variables in dense form.
std::vector
< OtherConstraintOption * > 
getOtherConstraintOptions (std::string solver_name)
 Get the array of other constraint options.
OtherConstraintOption ** getAllOtherConstraintOptions ()
 Get all <other> constraint options.
std::vector< SolverOption * > getSolverOptions (std::string solver_name)
 Get the options associated with a given solver.
std::vector< SolverOption * > getSolverOptions (std::string solver_name, bool getFreeOptions)
 Get the options associated with a given solver AND options not associated with any solver (if desired).
SolverOption ** getAllSolverOptions ()
 Get all solver options.
bool setServiceURI (std::string serviceURI)
 Set the serviceURI.
bool setServiceName (std::string serviceName)
 Set the service name.
bool setInstanceName (std::string instanceName)
 Set the instance name.
bool setInstanceLocation (std::string instanceLocation)
 Set the instance location.
bool setInstanceLocation (std::string instanceLocation, std::string locationType)
 Alternative signature to set the instance location and location type simultaneously.
bool setInstanceLocationType (std::string locationType)
 Set the instance location type.
bool setJobID (std::string jobID)
 Set the job ID.
bool setSolverToInvoke (std::string solverToInvoke)
 Set the solver to be invoked.
bool setLicense (std::string license)
 Set the license information.
bool setUserName (std::string userName)
 Set the username.
bool setPassword (std::string password)
 Set the password.
bool setContact (std::string contact)
 Set the contact information.
bool setContact (std::string contact, std::string transportType)
 Alternative signature to set the contact information and transport type simultaneously.
bool setContactTransportType (std::string transportType)
 Set the transport type for contact.
bool setOtherGeneralOptions (int numberOfOptions, OtherOption **other)
 Set the other general options as an entire array.
bool setAnOtherGeneralOption (std::string name, std::string value, std::string description)
 Add another general option to the general <other> option array.
bool setMinDiskSpace (std::string unit, std::string description, double value)
 set() options in the <system> element
bool setMinDiskSpace (double value)
bool setMinDiskSpaceUnit (std::string unit)
bool setMinMemorySize (std::string unit, std::string description, double value)
bool setMinMemorySize (double value)
bool setMinMemoryUnit (std::string unit)
bool setMinCPUSpeed (std::string unit, std::string description, double value)
bool setMinCPUSpeed (double value)
bool setMinCPUSpeedUnit (std::string unit)
bool setMinCPUNumber (int number, std::string description)
bool setMinCPUNumber (int number)
bool setOtherSystemOptions (int numberOfOptions, OtherOption **other)
bool setAnOtherSystemOption (std::string name, std::string value, std::string description)
bool setServiceType (std::string serviceType)
 set() options in the <service> element
bool setOtherServiceOptions (int numberOfOptions, OtherOption **other)
bool setAnOtherServiceOption (std::string name, std::string value, std::string description)
bool setMaxTime (double value, std::string unit)
bool setMaxTime (double value)
 set() options in the <job> element
bool setMaxTimeUnit (std::string unit)
bool setRequestedStartTime (std::string time)
bool setJobDependencies (int numberOfDependencies, std::string *jobDependencies)
bool setAnotherJobDependency (std::string jobID)
bool setRequiredDirectories (int numberOfPaths, std::string *paths)
bool setAnotherRequiredDirectory (std::string path)
bool setRequiredFiles (int numberOfPaths, std::string *paths)
bool setAnotherRequiredFile (std::string path)
bool setDirectoriesToMake (int numberOfPaths, std::string *paths)
bool setAnotherDirectoryToMake (std::string path)
bool setFilesToMake (int numberOfPaths, std::string *paths)
bool setAnotherFileToMake (std::string path)
bool setPathPairs (int object, std::string *from, std::string *to, bool *makeCopy, int numberOfPathPairs)
 setPathPairs set a number of path pairs into the OSOption object
bool setInputDirectoriesToMove (int numberOfPathPairs, PathPair **pathPair)
bool setAnotherInputDirectoryToMove (std::string fromPath, std::string toPath, bool makeCopy)
bool setInputFilesToMove (int numberOfPathPairs, PathPair **pathPair)
bool setAnotherInputFileToMove (std::string fromPath, std::string toPath, bool makeCopy)
bool setOutputFilesToMove (int numberOfPathPairs, PathPair **pathPair)
bool setAnotherOutputFileToMove (std::string fromPath, std::string toPath, bool makeCopy)
bool setOutputDirectoriesToMove (int numberOfPathPairs, PathPair **pathPair)
bool setAnotherOutputDirectoryToMove (std::string fromPath, std::string toPath, bool makeCopy)
bool setFilesToDelete (int numberOfPaths, std::string *paths)
bool setAnotherFileToDelete (std::string path)
bool setDirectoriesToDelete (int numberOfPaths, std::string *paths)
bool setAnotherDirectoryToDelete (std::string path)
bool setProcessesToKill (int numberOfProcesses, std::string *processes)
bool setAnotherProcessToKill (std::string process)
bool setOtherJobOptions (int numberOfOptions, OtherOption **other)
bool setAnOtherJobOption (std::string name, std::string value, std::string description)
bool setNumberOfVariables (int numberOfVariables)
bool setNumberOfObjectives (int numberOfObjectives)
bool setNumberOfConstraints (int numberOfConstraints)
bool setInitVarValues (int numberOfVar, int *idx, double *value, std::string *name)
bool setInitVarValuesSparse (int numberOfVar, InitVarValue **var)
bool setInitVarValuesDense (int numberOfVar, double *value)
bool setAnotherInitVarValue (int idx, double value)
bool setInitVarValuesString (int numberOfVar, int *idx, std::string *value, std::string *name)
bool setInitVarValuesStringSparse (int numberOfVar, InitVarValueString **var)
bool setInitVarValuesStringDense (int numberOfVar, std::string *value)
bool setAnotherInitVarValueString (int idx, std::string value)
bool setInitBasisStatus (int object, int status, int *i, int ni)
bool setInitBasisStatusSparse (int numberOfVar, InitBasStatus **var)
bool setInitBasisStatusDense (int numberOfVar, std::string *var)
bool setAnotherInitBasisStatus (int type, int idx, int status)
 Set the basis status for another variable, objective or constraint/slack.
bool setIntegerVariableBranchingWeights (int numberOfVar, int *idx, double *value, std::string *name)
bool setIntegerVariableBranchingWeightsSparse (int numberOfVar, BranchingWeight **var)
bool setIntegerVariableBranchingWeightsDense (int numberOfVar, double *value)
bool setAnotherIntegerVariableBranchingWeight (int idx, double value)
bool setSOSVariableBranchingWeights (int numberOfSOS, SOSWeights **sos)
bool setAnotherSOSVariableBranchingWeight (int sosIdx, int nvar, double weight, int *idx, double *value, std::string *name)
bool setNumberOfOtherVariableOptions (int numberOfOther)
bool setOtherVariableOptions (int numberOfVar, OtherVariableOption **var)
bool setAnOtherVariableOption (OtherVariableOption *varOption)
bool setOtherVariableOptionAttributes (int iOther, int numberOfVar, int numberOfEnumerations, std::string name, std::string value, std::string solver, std::string category, std::string type, std::string description)
 Set the attributes for one particular <other> <variable> option.
bool setOtherOptionEnumeration (int object, int otherOptionNumber, int enumerationNumber, int numberOfEl, std::string value, std::string description, int *idxArray)
 Set one enumeration associated with an <other> option in the <variables>, <objectives> or <constraints> element.
bool setOtherVariableOptionVar (int otherOptionNumber, int varNumber, int idx, std::string name, std::string value, std::string lbValue, std::string ubValue)
 Set one element associated with an <other> option in the <variables> element.
bool setInitObjValues (int numberOfObj, int *idx, double *value, std::string *name)
bool setInitObjValuesSparse (int numberOfObj, InitObjValue **obj)
bool setInitObjValuesDense (int numberOfObj, double *value)
bool setAnotherInitObjValue (int idx, double value)
bool setInitObjBounds (int numberOfObj, int *idx, double *lbValue, double *ubValue, std::string *name)
bool setInitObjBoundsSparse (int numberOfObj, InitObjBound **obj)
bool setInitObjBoundsDense (int numberOfObj, double *lb, double *ub)
bool setAnotherInitObjBound (int idx, double lbValue, double ubValue)
bool setNumberOfOtherObjectiveOptions (int numberOfOther)
bool setOtherObjectiveOptions (int numberOfObj, OtherObjectiveOption **obj)
bool setAnOtherObjectiveOption (OtherObjectiveOption *objOption)
bool setOtherObjectiveOptionAttributes (int iOther, int numberOfObj, int numberOfEnumerations, std::string name, std::string value, std::string solver, std::string category, std::string type, std::string description)
 Set the attributes for one particular <other> <objective> option.
bool setOtherObjectiveOptionObj (int otherOptionNumber, int objNumber, int idx, std::string name, std::string value, std::string lbValue, std::string ubValue)
 Set one <obj> element associated with an <other> option in the <objectives> element.
bool setInitConValues (int numberOfCon, int *idx, double *value, std::string *name)
bool setInitConValuesSparse (int numberOfCon, InitConValue **con)
bool setInitConValuesDense (int numberOfCon, double *value)
bool setAnotherInitConValue (int idx, double value)
bool setInitDualValues (int numberOfCon, int *idx, double *lbValue, double *ubValue, std::string *name)
bool setInitDualVarValuesSparse (int numberOfCon, InitDualVarValue **con)
bool setInitDualVarValuesDense (int numberOfCon, double *lb, double *ub)
bool setAnotherInitDualVarValue (int idx, double lbValue, double ubValue)
bool setNumberOfOtherConstraintOptions (int numberOfOther)
bool setOtherConstraintOptions (int numberOfOptions, OtherConstraintOption **other)
bool setAnOtherConstraintOption (OtherConstraintOption *optionValue)
bool setOtherConstraintOptionAttributes (int iOther, int numberOfCon, int numberOfEnumerations, std::string name, std::string value, std::string solver, std::string category, std::string type, std::string description)
 Set the attributes for one particular <other> <constraint> option.
bool setOtherConstraintOptionCon (int otherOptionNumber, int conNumber, int idx, std::string name, std::string value, std::string lbValue, std::string ubValue)
 Set one <con> element associated with an <other> option in the <constraints> element.
bool setNumberOfSolverOptions (int numberOfOptions)
bool setSolverOptionContent (int iOption, int numberOfItems, std::string name, std::string value, std::string solver, std::string category, std::string type, std::string description, std::string *itemList)
 Set the attributes for one particular solver option.
bool setSolverOptions (int numberOfSolverOptions, SolverOption **solverOption)
bool setAnotherSolverOption (std::string name, std::string value, std::string solver, std::string category, std::string type, std::string description)
bool setOptionInt (std::string optionName, int optionValue)
bool setOptionStr (std::string optionName, std::string optionValue)
bool setOptionDbl (std::string optionName, double value)

Public Attributes

GeneralFileHeaderoptionHeader
 OSOption has a header and five other children: general, system, service, job, and optimization.
GeneralOptiongeneral
 generalOption holds the first child of the OSOption specified by the OSoL Schema.
SystemOptionsystem
 systemOption holds the second child of the OSOption specified by the OSoL Schema.
ServiceOptionservice
 serviceOption holds the third child of the OSOption specified by the OSoL Schema.
JobOptionjob
 jobOption holds the fourth child of the OSOption specified by the OSoL Schema.
OptimizationOptionoptimization
 optimizationOption holds the fifth child of the OSOption specified by the OSoL Schema.

Private Attributes

double * m_mdInitVarValuesDense
 m_mdInitVarValuesDense holds the initial variable values in dense form
std::string * m_mdInitVarValuesStringDense
 m_mdInitVarValuesStringDense holds the initial values for string-valued variables
int * m_mdInitBasisStatusDense
 m_mdInitBasisStatusDense holds the initial basis status in dense form
double * m_mdIntegerVariableBranchingWeightsDense
 m_mdIntegerVariableBranchingWeightsDense holds the branching weights for integer variables
double * m_mdInitObjValuesDense
 m_mdInitObjValuesDense holds initial objective values in dense form
double * m_mdInitObjLowerBoundsDense
 m_mdInitObjLowerBoundsDense holds initial lower bounds for the objectives in dense form
double * m_mdInitObjUpperBoundsDense
 m_mdInitObjUpperBoundsDense holds initial upper bounds for the objectives in dense form
double * m_mdInitConValuesDense
 m_mdInitConValuesDense holds initial constraint values in dense form
double * m_mdInitDualVarLowerBoundsDense
 m_mdInitDualVarLowerBoundsDense holds initial dual values for the lower bound of the constraints in dense form
double * m_mdInitDualVarUpperBoundsDense
 m_mdInitDualVarUpperBoundsDense holds initial dual values for the upper bound of the constraints in dense form

Detailed Description

The Option Class.

Author:
Robert Fourer, Gus Gassmann, Jun Ma, Kipp Martin
Version:
1.0, 21/07/2008
Since:
OS 1.1
Remarks:
A class for holding all the solver options information.

Definition at line 3097 of file OSOption.h.


Constructor & Destructor Documentation

OSOption::OSOption (  ) 

Default constructor.

Definition at line 1258 of file OSOption.cpp.

OSOption::~OSOption (  ) 

Class destructor.

Definition at line 1283 of file OSOption.cpp.


Member Function Documentation

bool OSOption::setOptionHeader ( std::string  name,
std::string  source,
std::string  fileCreator,
std::string  description,
std::string  licence 
)

A function to populate an instance of the option header element.

set option header

Parameters:
name,: the name of this file or instance
source,: the source (e.g., in BiBTeX format)
fileCreator,: the creator of this file
description,: further description about this file and/or its contents
licence,: licence information if applicable

Definition at line 6770 of file OSOption.cpp.

bool OSOption::IsEqual ( OSOption that  ) 

A function to check for the equality of two objects.

Definition at line 8763 of file OSOption.cpp.

bool OSOption::setRandom ( double  density,
bool  conformant 
)

A function to make a random instance of this class.

Parameters:
density,: corresponds to the probability that a particular child element is created
conformant,: if true enforces side constraints not enforceable in the schema (e.g., agreement of "numberOfXXX" attributes and <XXX> children)

Definition at line 11081 of file OSOption.cpp.

std::string OSOption::getFileName (  ) 

Get the name of the file.

get the file name (in <optionHeader> element)

Definition at line 1356 of file OSOption.cpp.

std::string OSOption::getFileSource (  ) 

Get the source of the file or problem.

get the file source (in <optionHeader> element)

Definition at line 1367 of file OSOption.cpp.

std::string OSOption::getFileDescription (  ) 

Get a description for the file or problem.

get the file description (in <optionHeader> element)

Definition at line 1378 of file OSOption.cpp.

std::string OSOption::getFileCreator (  ) 

Get the name of the person who created the file.

get the file creator (in <optionHeader> element)

Definition at line 1389 of file OSOption.cpp.

std::string OSOption::getFileLicence (  ) 

Get licence information associated with the file.

get the file licence information (in <optionHeader> element)

Definition at line 1400 of file OSOption.cpp.

std::string OSOption::getServiceURI (  ) 

Get the service URI.

get the service URI (in <general> element)

Definition at line 1412 of file OSOption.cpp.

std::string OSOption::getServiceName (  ) 

Get the service name.

get the service name (in <general> element)

Definition at line 1423 of file OSOption.cpp.

std::string OSOption::getInstanceName (  ) 

Get the instance name.

get the instance name (in <general> element)

Definition at line 1434 of file OSOption.cpp.

std::string OSOption::getInstanceLocation (  ) 

Get the instance location.

get the instance location (in <general> element)

Definition at line 1445 of file OSOption.cpp.

std::string OSOption::getInstanceLocationType (  ) 

Get the location type.

get the instance location type (in <general> element)

Definition at line 1457 of file OSOption.cpp.

std::string OSOption::getJobID (  ) 

Get the job ID.

get the job ID (in <general> element)

Definition at line 1469 of file OSOption.cpp.

std::string OSOption::getSolverToInvoke (  ) 

Get the solver name.

get the name of the solver to be invoked (in <general> element)

Definition at line 1480 of file OSOption.cpp.

std::string OSOption::getLicense (  ) 

Get the license string.

get the license information (in <general> element)

Definition at line 1491 of file OSOption.cpp.

std::string OSOption::getUserName (  ) 

Get the user name.

get the user name (in <general> element)

Definition at line 1502 of file OSOption.cpp.

std::string OSOption::getPassword (  ) 

Get the password.

get the password (in <general> element)

Definition at line 1513 of file OSOption.cpp.

std::string OSOption::getContact (  ) 

Get the contact information.

get the contact information (in <general> element)

Definition at line 1524 of file OSOption.cpp.

std::string OSOption::getContactTransportType (  ) 

Get the transport type.

get the transport type (in <general> element)

Definition at line 1536 of file OSOption.cpp.

std::string OSOption::getMinDiskSpaceUnit (  ) 

Get the disk space unit.

get the disk space units (in <system> element)

Definition at line 1548 of file OSOption.cpp.

std::string OSOption::getMinDiskSpaceDescription (  ) 

get the disk space description

get the disk space description (in <system> element)

Definition at line 1560 of file OSOption.cpp.

std::string OSOption::getMinMemoryUnit (  ) 

Get the memory unit.

get the memory units (in <system> element)

Definition at line 1572 of file OSOption.cpp.

std::string OSOption::getMinMemoryDescription (  ) 

get the memory description

get the memory description (in <system> element)

Definition at line 1584 of file OSOption.cpp.

std::string OSOption::getMinCPUSpeedUnit (  ) 

Get the CPU speed unit.

get the CPU speed units (in <system> element)

Definition at line 1596 of file OSOption.cpp.

std::string OSOption::getMinCPUSpeedDescription (  ) 

Get the CPU speed description.

get the CPU speed description (in <system> element)

Definition at line 1608 of file OSOption.cpp.

std::string OSOption::getMinCPUNumberDescription (  ) 

Get the CPU description.

get the CPU description (in <system> element)

Definition at line 1620 of file OSOption.cpp.

std::string OSOption::getServiceType (  ) 

Get the service type.

get the service type (in <service> element)

Definition at line 1632 of file OSOption.cpp.

std::string OSOption::getMaxTimeUnit (  ) 

Get the time unit.

get the time unit (in <job> element)

Definition at line 1643 of file OSOption.cpp.

std::string OSOption::getRequestedStartTime (  ) 

Get the requested starting time.

get the requested start time (in <job> element)

Definition at line 1655 of file OSOption.cpp.

std::string OSOption::getOptionStr ( std::string  optionName  ) 

Get any of the string-valued options.

get the value of a string-valued option

Parameters:
optionName The name of the option
Returns:
the value of the option optionName
Note:
This function returns the empty string "" if optionName is not found

Definition at line 1669 of file OSOption.cpp.

double OSOption::getMinDiskSpace (  ) 

Get the minimum required disk space.

get the minimum disk space required (in <system> element)

Definition at line 1735 of file OSOption.cpp.

double OSOption::getMinMemorySize (  ) 

Get the minimum required memory.

get the minimum memory required (in <system> element)

Definition at line 1747 of file OSOption.cpp.

double OSOption::getMinCPUSpeed (  ) 

Get the minimum required CPU speed.

get the minimum CPU speed required (in <system> element)

Definition at line 1759 of file OSOption.cpp.

double OSOption::getMaxTime (  ) 

Get the maximum allowed time.

get the maximum time allowed (in <job> element)

Definition at line 1771 of file OSOption.cpp.

double OSOption::getOptionDbl ( std::string  optionName  ) 

Get any of the double-valued options.

get the value of a double-valued option

Parameters:
optionName The name of the option
Returns:
the value of the option optionName
Note:
returns 0 if optionName is not found

Definition at line 1786 of file OSOption.cpp.

int OSOption::getMinCPUNumber (  ) 

Get the minimum required number of CPUs.

get() methods that return integers

get the minimum number of CPUs required (in <system> element)

Definition at line 1810 of file OSOption.cpp.

int OSOption::getNumberOfOtherGeneralOptions (  ) 

Get the number of <other> options in the <general> element.

get the number of other <general> options

Definition at line 1821 of file OSOption.cpp.

int OSOption::getNumberOfOtherSystemOptions (  ) 

Get the number of <other> options in the <system> element.

get the number of other <system> options

Definition at line 1833 of file OSOption.cpp.

int OSOption::getNumberOfOtherServiceOptions (  ) 

Get the number of <other> options in the <service> element.

get the number of other <service> options

Definition at line 1845 of file OSOption.cpp.

int OSOption::getNumberOfOtherJobOptions (  ) 

Get the number of <other> options in the <job> element.

get the number of other <job> options

Definition at line 1857 of file OSOption.cpp.

int OSOption::getNumberOfJobDependencies (  ) 

Get the number of job dependencies.

get the number of job dependencies (in <job> element)

Definition at line 1869 of file OSOption.cpp.

int OSOption::getNumberOfRequiredDirectories (  ) 

Get the number of required directories.

get the number of required directories (in <job> element)

Definition at line 1881 of file OSOption.cpp.

int OSOption::getNumberOfRequiredFiles (  ) 

Get the number of required files.

get the number of required files (in <job> element)

Definition at line 1893 of file OSOption.cpp.

int OSOption::getNumberOfDirectoriesToMake (  ) 

Get the number of directories to make.

get the number of directories to make (in <job> element)

Definition at line 1905 of file OSOption.cpp.

int OSOption::getNumberOfFilesToMake (  ) 

Get the number of files to make.

get the number of files to create (in <job> element)

Definition at line 1917 of file OSOption.cpp.

int OSOption::getNumberOfInputDirectoriesToMove (  ) 

Get the number of input directories to move.

get the number of input directories to move or copy (in <job> element)

Definition at line 1929 of file OSOption.cpp.

int OSOption::getNumberOfInputFilesToMove (  ) 

Get the number of input files to move.

get the number of input files to move or copy (in <job> element)

Definition at line 1941 of file OSOption.cpp.

int OSOption::getNumberOfOutputDirectoriesToMove (  ) 

Get the number of output directories to move.

get the number of output directories to move or copy (in <job> element)

Definition at line 1953 of file OSOption.cpp.

int OSOption::getNumberOfOutputFilesToMove (  ) 

Get the number of output files to move.

get the number of output files to move or copy (in <job> element)

Definition at line 1965 of file OSOption.cpp.

int OSOption::getNumberOfFilesToDelete (  ) 

Get the number of files to delete.

get the number of files to delete (in <job> element)

Definition at line 1977 of file OSOption.cpp.

int OSOption::getNumberOfDirectoriesToDelete (  ) 

Get the number of directories to delete.

get the number of directories to delete (in <job> element)

Definition at line 1989 of file OSOption.cpp.

int OSOption::getNumberOfProcessesToKill (  ) 

Get the number of processes to kill.

get the number of processes to kill (in <job> element)

Definition at line 2001 of file OSOption.cpp.

int OSOption::getNumberOfVariables (  ) 

Get the number of variables in the instance.

get the number of variables (in <optimization> element)

Definition at line 2013 of file OSOption.cpp.

int OSOption::getNumberOfObjectives (  ) 

Get the number of objectives in the instance.

get the number of objectives (in <optimization> element)

Definition at line 2024 of file OSOption.cpp.

int OSOption::getNumberOfConstraints (  ) 

Get the number of constraints in the instance.

get the number of constraints (in <optimization> element)

Definition at line 2035 of file OSOption.cpp.

int OSOption::getNumberOfInitVarValues (  ) 

Get the number of initial variable values.

get the number of variables that have initial values (in <optimization> element)

Returns:
the number of initial variable values.

Definition at line 2047 of file OSOption.cpp.

int OSOption::getNumberOfInitVarValuesString (  ) 

Get the number of initial variable strings.

get the number of string-valued variables that have initial values (in <optimization> element)

Returns:
the number of initial variable strings.

Definition at line 2065 of file OSOption.cpp.

int OSOption::getNumberOfIntegerVariableBranchingWeights (  ) 

Get the number of variables for which integer branching weights are provided.

get the number of variables that are given integer branching weights (in <optimization> element)

Returns:
the number of variables.

Definition at line 2078 of file OSOption.cpp.

int OSOption::getNumberOfSOS (  ) 

Get the number of special ordered sets for which branching weights are provided.

get the number of SOS that are given branching weights (in <optimization> element)

Returns:
the number of variables.

Definition at line 2090 of file OSOption.cpp.

int OSOption::getNumberOfSOSVarBranchingWeights ( int  iSOS  ) 

Get the number of variables for which branching weights are provided in a particular SOS.

get the number of variables that are given integer branching weights (in <optimization> element)

Parameters:
iSOS the number of the SOS
Returns:
the number of variables.

Definition at line 2102 of file OSOption.cpp.

int OSOption::getNumberOfOtherVariableOptions (  ) 

Get the number of other variable options.

get the number of other variable options (in <optimization> element)

Returns:
the number of other variable options.

Definition at line 2118 of file OSOption.cpp.

int OSOption::getNumberOfInitObjValues (  ) 

Get the number of initial objective values.

get the number of objectives for which initial values are given (in <optimization> element)

Returns:
the number of initial objective values.

Definition at line 2130 of file OSOption.cpp.

int OSOption::getNumberOfInitObjBounds (  ) 

Get the number of initial objective bounds.

get the number of objectives for which initial bounds are given (in <optimization> element)

Returns:
the number of initial objective bound values.

Definition at line 2143 of file OSOption.cpp.

int OSOption::getNumberOfOtherObjectiveOptions (  ) 

Get the number of other objective options.

get the number of other objective options (in <optimization> element)

Returns:
the number of other objective options.

Definition at line 2155 of file OSOption.cpp.

int OSOption::getNumberOfInitConValues (  ) 

Get the number of initial constraint values.

get the number of constraints for which initial values are given (in <optimization> element)

Returns:
the number of initial constraint values.

Definition at line 2166 of file OSOption.cpp.

int OSOption::getNumberOfInitDualVarValues (  ) 

Get the number of initial dual variable values.

get the number of constraints for which initial dual values are given (in <optimization> element)

Returns:
the number of initial dual variable values.

Definition at line 2178 of file OSOption.cpp.

int OSOption::getNumberOfOtherConstraintOptions (  ) 

Get the number of other constraint options.

get the number of other constraint options (in <optimization> element)

Returns:
the number of other constraint options.

Definition at line 2191 of file OSOption.cpp.

int OSOption::getNumberOfSolverOptions (  ) 

Get the number of solver options.

get the number of other solver options (in <optimization> element)

Returns:
the number of solver options.

Definition at line 2203 of file OSOption.cpp.

int OSOption::getOptionInt ( std::string  optionName  ) 

Get any of the integer-valued options.

get the value of an integer-valued option

Parameters:
optionName The name of the option
Returns:
the value of the option optionName
Note:
This function returns -1 if optionName is not found

Definition at line 2218 of file OSOption.cpp.

OtherOption ** OSOption::getOtherGeneralOptions (  ) 

Get the array of other options associated with the <general> element.

get the array of other <general> options

Returns:
a vector of pointers to otherOptions objects associated with the <general> element

Definition at line 2327 of file OSOption.cpp.

OtherOption ** OSOption::getOtherSystemOptions (  ) 

Get the array of other options associated with the <system> element.

get the array of other <system> options

Returns:
a vector of pointers to otherOptions objects associated with the <system> element

Definition at line 2340 of file OSOption.cpp.

OtherOption ** OSOption::getOtherServiceOptions (  ) 

Get the array of other options associated with the <service> element.

get the array of other <service> options

Returns:
a vector of pointers to otherOptions objects associated with the <service> element

Definition at line 2353 of file OSOption.cpp.

OtherOption ** OSOption::getOtherJobOptions (  ) 

Get the array of other options associated with the <job> element.

get the array of other <job> options

Returns:
a vector of pointers to otherOptions objects associated with the <job> element

Definition at line 2366 of file OSOption.cpp.

OtherOption ** OSOption::getOtherOptions ( std::string  category  ) 

Get the array of other options associated with any element.

get the array of other options associated with a category

Returns:
a vector of pointers to otherOptions objects associated with the element whose name matches elementName
Parameters:
category - The name of the option category
Returns:
other options associated with the element <"category">
Note:
This function returns NULL if category is not found

Definition at line 2382 of file OSOption.cpp.

OtherOption ** OSOption::getAllOtherOptions (  ) 

Get the array of all other options associated with the <general>, <system>, <service> and <job> elements.

get the array of other options associated with all children of <osol>

Returns:
a vector of pointers to all otherOptions objects

Definition at line 2402 of file OSOption.cpp.

std::string * OSOption::getJobDependencies (  ) 

Get the array of job dependencies.

get the array of job dependencies

Returns:
a vector of pointers to JobDependencies objects

Definition at line 2495 of file OSOption.cpp.

std::string * OSOption::getRequiredDirectories (  ) 

Get the array of required directories.

get the list of required directories

Returns:
a vector of pointers to DirectoriesAndFiles objects giving the directories that are required by the current job

Definition at line 2514 of file OSOption.cpp.

std::string * OSOption::getRequiredFiles (  ) 

Get the array of required files.

get the list of required files

Returns:
a vector of pointers to DirectoriesAndFiles objects giving the files that are required by the current job

Definition at line 2532 of file OSOption.cpp.

std::string * OSOption::getDirectoriesToMake (  ) 

Get the array of directories to make.

get the list of directories that need to be created

Returns:
a vector of pointers to DirectoriesAndFiles objects giving the directories that must be created

Definition at line 2550 of file OSOption.cpp.

std::string * OSOption::getFilesToMake (  ) 

Get the array of files to make.

get the list of files that need to be created

Returns:
a vector of pointers to DirectoriesAndFiles objects giving the files that must be created

Definition at line 2568 of file OSOption.cpp.

PathPair ** OSOption::getInputDirectoriesToMove (  ) 

Get the array of input directories to move.

get the list of input directories that need to be moved or copied

Returns:
a vector of pointers to PathPair objects giving the input directories that must be moved

Definition at line 2586 of file OSOption.cpp.

PathPair ** OSOption::getInputFilesToMove (  ) 

Get the array of input files to move.

get the list of input files that need to be moved or copied

Returns:
a vector of pointers to PathPair objects giving the input files that must be moved

Definition at line 2604 of file OSOption.cpp.

PathPair ** OSOption::getOutputDirectoriesToMove (  ) 

Get the array of output directories to move.

get the list of output directories that need to be moved or copied

Returns:
a vector of pointers to PathPair objects giving the output directories that must be moved

Definition at line 2640 of file OSOption.cpp.

PathPair ** OSOption::getOutputFilesToMove (  ) 

Get the array of output files to move.

get the list of output files that need to be moved or copied

Returns:
a vector of pointers to PathPair objects giving the output files that must be moved

Definition at line 2622 of file OSOption.cpp.

std::string * OSOption::getDirectoriesToDelete (  ) 

Get the array of directories to delete.

get the list of directories that need to be deleted

Returns:
a vector of pointers to DirectoriesAndFiles objects giving the directories that must be deleted

Definition at line 2676 of file OSOption.cpp.

std::string * OSOption::getFilesToDelete (  ) 

Get the array of files to delete.

get the list of files that need to be deleted

Returns:
a vector of pointers to DirectoriesAndFiles objects giving the files that must be deleted

Definition at line 2658 of file OSOption.cpp.

std::string * OSOption::getProcessesToKill (  ) 

Get the array of processes to kill.

get the list of processes that need to be killed

Returns:
a vector of pointers to Processes objects giving the processes that must be killed

Definition at line 2694 of file OSOption.cpp.

InitVarValue ** OSOption::getInitVarValuesSparse (  ) 

Get the initial values associated with the variables in sparse form.

get the list of initial variable values in sparse form

Returns:
a vector of pointers to InitVarValue objects that hold initial values for (some of) the variables
a list of index/value pairs

Definition at line 2715 of file OSOption.cpp.

double * OSOption::getInitVarValuesDense (  ) 

Get the initial values associated with the variables in dense form.

get the list of initial variable values in dense form

Returns:
a vector of double that holds initial values (or OSNaN()) for all of the variables
an array of values
Note:
return OSNaN() for variables that are not initialed

Definition at line 2740 of file OSOption.cpp.

double * OSOption::getInitVarValuesDense ( int  numberOfVariables  ) 

Get the initial values associated with the variables in dense form.

get the list of initial variable values in dense form

Parameters:
numberOfVariables holds the dimension of the vector
Returns:
a vector of double that holds initial values (or OSNaN()) for all of the variables
Parameters:
numberOfVariables is the dimension of the array
Returns:
an array of values
Note:
return OSNaN() for variables that are not initialed

Definition at line 2791 of file OSOption.cpp.

InitVarValueString ** OSOption::getInitVarValuesStringSparse (  ) 

Get the initial value strings associated with the variables in sparse form.

get the list of initial values for string-valued variables in sparse form

Returns:
a vector of pointers to InitVarValueString objects that hold initial value strings for (some of) the variables
a list of index/value pairs

Definition at line 2839 of file OSOption.cpp.

std::string * OSOption::getInitVarValuesStringDense (  ) 

Get the initial value strings associated with the variables in dense form.

get the list of initial values for string-valued variables in dense form

Returns:
a vector of strings that holds initial value strings (or "") for all of the variables
an array of value strings
Note:
return the empty string "" for variables that are not initialed

Definition at line 2864 of file OSOption.cpp.

std::string * OSOption::getInitVarValuesStringDense ( int  numberOfVariables  ) 

Get the initial value strings associated with the variables in dense form.

get the list of initial values for string-valued variables in dense form

Parameters:
numberOfVariables holds the dimension of the vector
Returns:
a vector of strings that holds initial value strings (or "") for all of the variables
Parameters:
numberOfVariables is the dimension of the array
Returns:
an array of value strings
Note:
return the empty string "" for variables that are not initialed

Definition at line 3706 of file OSOption.cpp.

InitBasStatus** OSOption::getInitBasisStatusSparse (  ) 

Get the initial basis status in sparse form.

Returns:
a vector of pointers to InitBasStatus objects that hold initial basis status for (some of) the variables
std::string* OSOption::getInitBasisStatusDense (  ) 

Get the initial basis information in dense form.

Returns:
a vector of strings that holds initial basis status (or "unknown") for all of the variables
int * OSOption::getVariableInitialBasisStatusDense ( int  numberOfVariables  ) 

Get the initial basis status for all variables in dense form.

get the list of initial values for string-valued variables in dense form

Returns:
an array of int, with values corresponding to ENUM_BASIS_STATUS -- see OSGeneral.h)
Note:
returns ENUM_BASIS_STATUS_unknown for variables that are not initialed
Parameters:
numberOfVariables is the dimension of the array
numberOfVariables is the dimension of the array
Returns:
an array of value strings
Note:
return the empty string "" for variables that are not initialed std::string *OSOptiongetInitVarValuesStringDense(int numberOfVariables) { try { if (numberOfVariables < 0) throw ErrorClass("\"numberOfVariables\" must be present to use dense methods");

if (this->optimization != NULL) { if (this->optimization->variables != NULL) { if (this->optimization->variables->initialVariableValuesString != NULL) { int i,j,k; int num_var; num_var = this->getNumberOfInitVarValuesString();

if (m_mdInitVarValuesStringDense != NULL) delete [] m_mdInitVarValuesStringDense; m_mdInitVarValuesStringDense = new std::string[numberOfVariables]; for (k = 0; k < numberOfVariables; k++) m_mdInitVarValuesStringDense[k] = "";

for (i = 0; i < num_var; i++) { j = this->optimization->variables->initialVariableValuesString->var[i]->idx; if (j >= 0 && j < numberOfVariables) m_mdInitVarValuesStringDense[j] = this->optimization->variables->initialVariableValuesString->var[i]->value; else throw ErrorClass("Variable index out of range"); } return m_mdInitVarValuesStringDense; } } } } catch(const ErrorClass& eclass) { throw ErrorClass(eclass.errormsg); } return NULL; }//getInitVarValuesStringDense get the basis status for all variables in dense form

Returns:
an array of int, with values corresponding to ENUM_BASIS_STATUS -- see OSGeneral.g
Note:
returns ENUM_BASIS_STATUS_unknown for variables that are not initialed
Parameters:
numberOfVariables is the dimension of the array

Definition at line 2958 of file OSOption.cpp.

int OSOption::getNumberOfInitialBasisElements ( int  type,
int  status 
)

Get the number of initial basis elements for a particular variable type and basis status.

Returns:
the number of elements
Parameters:
type,: the type of variable or problem component (contained in ENUM_PROBLEM_COMPONENT --- see OSGeneral.h)
status,: the basis status (contained in ENUM_BASIS_STATUS --- see OSGeneral.h)

Definition at line 3060 of file OSOption.cpp.

bool OSOption::getInitialBasisElements ( int  type,
int  status,
int *  elem 
)

Get the initial basis elements for a particular variable type and basis status.

Returns:
whether the operation was successful or not
Parameters:
type,: the type of variable or problem component (contained in ENUM_PROBLEM_COMPONENT --- see OSGeneral.h)
status,: the basis status (contained in ENUM_BASIS_STATUS --- see OSGeneral.h)
elem,: pointer to the memory location where the user wants to store the returned values

Definition at line 3102 of file OSOption.cpp.

BranchingWeight ** OSOption::getIntegerVariableBranchingWeightsSparse (  ) 

Get the integer branching weights in sparse form.

get a list of branching weights for integer variables in sparse form

Returns:
a vector of pointers to BranchingWeight objects that hold branching weights for (some of) the variables
a list of index/value pairs

Definition at line 3151 of file OSOption.cpp.

double * OSOption::getIntegerVariableBranchingWeightsDense (  ) 

Get the integer branching weights in dense form.

get a list of branching weights for integer variables in dense form

Returns:
a vector of double that holds branching weights (or OSNaN()) for all the variables
an array of values
Note:
return OSNaN() for variables that are not initialed

Definition at line 3177 of file OSOption.cpp.

double * OSOption::getIntegerVariableBranchingWeightsDense ( int  numberOfVariables  ) 

Get the integer branching weights in dense form.

get a list of branching weights for integer variables in dense form

Parameters:
numberOfVariables holds the dimension of the vector
Returns:
a vector of double that holds branching weights (or OSNaN()) for all the variables
Parameters:
numberOfVariables is the dimension of the array
Returns:
an array of values
Note:
return OSNaN() for variables that are not initialed

Definition at line 3228 of file OSOption.cpp.

SOSWeights ** OSOption::getSOSVariableBranchingWeightsSparse (  ) 

Get the SOS branching weights in sparse form.

get a list of branching weights for SOS variables in sparse form

Returns:
a vector of pointers to SOSWeights objects that hold branching weights for (some of) the variables contained in special ordered sets
a list of SOSWeights objects

Definition at line 3275 of file OSOption.cpp.

std::vector< OtherVariableOption * > OSOption::getOtherVariableOptions ( std::string  solver_name  ) 

Get the <other> variable options associated with a particular solver.

get the array of other variable options associated with a particular solver

Parameters:
solver_name is the name of the solver whose options we want
Returns:
a vector of pointers to OtherVariableOption objects that correspond to the solver named.
Parameters:
solver_name is the name of the solver
Returns:
an array of other variable options associated with this solver

Definition at line 3301 of file OSOption.cpp.

OtherVariableOption ** OSOption::getAllOtherVariableOptions (  ) 

Get all <other> variable options.

get the array of all other variable options

Returns:
a pointer to an array of OtherVariableOption objects
an array of other variable options associated with this solver

Definition at line 3328 of file OSOption.cpp.

InitObjValue ** OSOption::getInitObjValuesSparse (  ) 

Get the initial values associated with the objectives in sparse form.

get the list of initial objective values in sparse form

Returns:
a vector of pointers to InitObjValue objects that hold initial values for (some of) the objectives
a list of index/value pairs

Definition at line 3347 of file OSOption.cpp.

double * OSOption::getInitObjValuesDense (  ) 

Get the initial values associated with the objectives in dense form.

get the list of initial objective values in dense form

Returns:
a vector of double that hold initial values (or OSNaN()) for all of the objectives
an array of values
Note:
return OSNaN() for objectives that are not initialed

Definition at line 3372 of file OSOption.cpp.

double * OSOption::getInitObjValuesDense ( int  numberOfObjectives  ) 

Get the initial values associated with the objectives in dense form.

get the list of initial objective values in dense form

Parameters:
numberOfObjectives holds the dimension of the vector
Returns:
a vector of double that hold initial values (or OSNaN()) for all of the objectives
Parameters:
numberOfObjectives is the dimension of the array
Returns:
an array of values
Note:
return OSNaN() for objectives that are not initialed

Definition at line 3425 of file OSOption.cpp.

InitObjBound ** OSOption::getInitObjBoundsSparse (  ) 

Get the initial bounds associated with the objectives in sparse form.

get the list of initial objective bounds in sparse form

Returns:
a vector of pointers to InitObjBound objects that hold initial bounds for (some of) the objectives
a list of index/value/value triples

Definition at line 3474 of file OSOption.cpp.

double * OSOption::getInitObjLowerBoundsDense (  ) 

Get the initial lower bounds associated with the objectives in dense form.

get the list of initial objective lower bounds in dense form

Returns:
a vector of double that hold initial lower bounds (or OSNaN()) for all of the objectives
an array of values
Note:
return OSNaN() for objectives that are not initialed

Definition at line 3499 of file OSOption.cpp.

double * OSOption::getInitObjLowerBoundsDense ( int  numberOfObjectives  ) 

Get the initial lower bounds associated with the objectives in dense form.

get the list of initial objective lower bounds in dense form

Parameters:
numberOfObjectives holds the dimension of the vector
Returns:
a vector of double that hold initial lower bounds (or OSNaN()) for all of the objectives
Parameters:
numberOfObjectives is the dimension of the array
Returns:
an array of values
Note:
return OSNaN() for objectives that are not initialed

Definition at line 3552 of file OSOption.cpp.

double * OSOption::getInitObjUpperBoundsDense (  ) 

Get the initial upper bounds associated with the objectives in dense form.

get the list of initial objective upper bounds in dense form

Returns:
a vector of double that hold initial upper bounds (or OSNaN()) for all of the objectives
an array of values
Note:
return OSNaN() for objectives that are not initialed

Definition at line 3602 of file OSOption.cpp.

double * OSOption::getInitObjUpperBoundsDense ( int  numberOfObjectives  ) 

Get the initial upper bounds associated with the objectives in dense form.

get the list of initial objective upper bounds in dense form

Parameters:
numberOfObjectives holds the dimension of the vector
Returns:
a vector of double that hold initial upper bounds (or OSNaN()) for all of the objectives
Parameters:
numberOfObjectives is the dimension of the array
Returns:
an array of values
Note:
return OSNaN() for objectives that are not initialed

Definition at line 3655 of file OSOption.cpp.

int * OSOption::getObjectiveInitialBasisStatusDense ( int  numberOfObjectives  ) 

Get the initial basis status for all objectives in dense form.

get the basis status for all objectives in dense form

Returns:
an array of int, with values corresponding to ENUM_BASIS_STATUS -- see OSGeneral.h)
Note:
returns ENUM_BASIS_STATUS_unknown for objectives that are not initialed
Parameters:
numberOfObjectives is the dimension of the array
Returns:
an array of int, with values corresponding to ENUM_BASIS_STATUS -- see OSGeneral.g
Note:
returns ENUM_BASIS_STATUS_unknown for objectives that are not initialed
Parameters:
numberOfObjectives is the dimension of the array

Definition at line 3757 of file OSOption.cpp.

std::vector< OtherObjectiveOption * > OSOption::getOtherObjectiveOptions ( std::string  solver_name  ) 

Get the array of other objective options.

get the array of other objective options associated with a particular solver

Parameters:
solver_name is the name of the solver whose options we want
Returns:
a vector of pointers to OtherConstraintOption objects
Parameters:
solver_name is the name of the solver
Returns:
an array of other objective options associated with this solver

Definition at line 3865 of file OSOption.cpp.

OtherObjectiveOption ** OSOption::getAllOtherObjectiveOptions (  ) 

Get all <other> objective options.

get the array of all other objective options

Returns:
a pointer to an array of OtherObjectiveOption objects
an array of other objective options associated with this solver

Definition at line 3891 of file OSOption.cpp.

InitConValue ** OSOption::getInitConValuesSparse (  ) 

Get the initial values associated with the constraints in sparse form.

get the list of initial constraint values in sparse form

Returns:
a vector of pointers to InitConValue objects that hold initial values for (some of) the constraints
a list of index/value pairs

Definition at line 3911 of file OSOption.cpp.

double * OSOption::getInitConValuesDense (  ) 

Get the initial values associated with the constraints in dense form.

get the list of initial constraint values in dense form

Returns:
a vector of double that hold initial values for all of the constraints
an array of values
Note:
return OSNaN() for constraints that are not initialed

Definition at line 3936 of file OSOption.cpp.

double * OSOption::getInitConValuesDense ( int  numberOfConstraints  ) 

Get the initial values associated with the constraints in dense form.

get the list of initial constraint values in dense form

Parameters:
numberOfConstraints holds the dimension of the vector
Returns:
a vector of double that hold initial values for all of the constraints
Parameters:
numberOfConstraints is the dimension of the array
Returns:
an array of values
Note:
return OSNaN() for constraints that are not initialed

Definition at line 3987 of file OSOption.cpp.

InitDualVarValue ** OSOption::getInitDualVarValuesSparse (  ) 

Get the initial bounds associated with the dual variables in sparse form.

get the list of initial dual variables in sparse form

Returns:
a vector of pointers to InitDualVarValue objects that hold initial bounds for (some of) the dual variables
a list of index/value/value triples

Definition at line 4034 of file OSOption.cpp.

double * OSOption::getInitDualVarLowerBoundsDense (  ) 

Get the initial dual variables associated with the lower bounds in dense form.

get the list of initial dual variables associated with the lower bounds in dense form

Returns:
a vector of double that hold initial lower bounds for all of the dual variables
an array of values
Note:
return OSNaN() for dual variables that are not initialed

Definition at line 4059 of file OSOption.cpp.

double * OSOption::getInitDualVarLowerBoundsDense ( int  numberOfConstraints  ) 

Get the initial dual variables associated with the lower bounds in dense form.

get the list of initial dual variables associated with the lower bounds in dense form

Parameters:
numberOfConstraints holds the dimension of the vector
Returns:
a vector of double that hold initial lower bounds for all of the dual variables
Parameters:
numberOfConstraints is the dimension of the array
Returns:
an array of values
Note:
return OSNaN() for dual variables that are not initialed

Definition at line 4111 of file OSOption.cpp.

double * OSOption::getInitDualVarUpperBoundsDense (  ) 

Get the initial dual variables associated with the upper bounds in dense form.

get the list of initial dual variables associated with the upper bounds in dense form

Returns:
a vector of double that hold initial upper bounds for all of the dual variables
an array of values
Note:
return OSNaN() for dual variables that are not initialed

Definition at line 4159 of file OSOption.cpp.

double * OSOption::getInitDualVarUpperBoundsDense ( int  numberOfConstraints  ) 

Get the initial dual variables associated with the upper bounds in dense form.

get the list of initial dual variables associated with the upper bounds in dense form

Parameters:
numberOfConstraints holds the dimension of the vector
Returns:
a vector of double that hold initial upper bounds for all of the dual variables
Parameters:
numberOfConstraints is the dimension of the array
Returns:
an array of values
Note:
return OSNaN() for dual variables that are not initialed

Definition at line 4211 of file OSOption.cpp.

int * OSOption::getSlackVariableInitialBasisStatusDense ( int  numberOfConstraints  ) 

Get the initial basis status for all slack variables in dense form.

get the basis status for all slack variables in dense form

Returns:
an array of int, with values corresponding to ENUM_BASIS_STATUS -- see OSGeneral.h)
Note:
returns ENUM_BASIS_STATUS_unknown for slack variables that are not initialed
Parameters:
numberOfConstraints is the dimension of the array
Returns:
an array of int, with values corresponding to ENUM_BASIS_STATUS -- see OSGeneral.g
Note:
returns ENUM_BASIS_STATUS_unknown for slackss that are not initialed
Parameters:
numberOfConstraints is the dimension of the array

Definition at line 4262 of file OSOption.cpp.

std::vector< OtherConstraintOption * > OSOption::getOtherConstraintOptions ( std::string  solver_name  ) 

Get the array of other constraint options.

get the array of other constraint options associated with a particular solver

Parameters:
solver_name is the name of the solver whose options we want
Returns:
a vector of pointers to OtherConstraintOption objects
Parameters:
solver_name is the name of the solver
Returns:
an array of other constraint options associated with this solver

Definition at line 4368 of file OSOption.cpp.

OtherConstraintOption ** OSOption::getAllOtherConstraintOptions (  ) 

Get all <other> constraint options.

get the array of all other constraint options

Returns:
a pointer to an array of OtherConstraintOption objects
an array of other constraint options associated with this solver

Definition at line 4394 of file OSOption.cpp.

std::vector< SolverOption * > OSOption::getSolverOptions ( std::string  solver_name  ) 

Get the options associated with a given solver.

get the array of solver options associated with a particular solver

Parameters:
solver_name is the name of the solver whose options we want
Returns:
a vector of pointers to SolverOption objects that correspond to the solver named.
Parameters:
solver_name is the name of the solver
Returns:
an array of solver options associated with this solver

Definition at line 4415 of file OSOption.cpp.

std::vector< SolverOption * > OSOption::getSolverOptions ( std::string  solver_name,
bool  getFreeOptions 
)

Get the options associated with a given solver AND options not associated with any solver (if desired).

get the array of solver options associated with a particular solver and the solver options not associated with any solver (if desired)

Parameters:
solver_name is the name of the solver whose options we want
getFreeOptions is a boolean set to true if the free options (not associated with a solver name) should be returned
Returns:
a vector of pointers to SolverOption objects that correspond to the solver named.
Parameters:
solver_name is the name of the solver
getFreeOptions is a boolean controlling whether unassociated (free) options should be returned or not
Returns:
an array of solver options associated with this solver

Definition at line 4446 of file OSOption.cpp.

SolverOption ** OSOption::getAllSolverOptions (  ) 

Get all solver options.

get the array of all solver options

Returns:
a pointer to an array SolverOption objects
an array of other constraint options associated with this solver

Definition at line 4474 of file OSOption.cpp.

bool OSOption::setServiceURI ( std::string  serviceURI  ) 

Set the serviceURI.

set() options in the <general> element

Definition at line 6782 of file OSOption.cpp.

bool OSOption::setServiceName ( std::string  serviceName  ) 

Set the service name.

Definition at line 6790 of file OSOption.cpp.

bool OSOption::setInstanceName ( std::string  instanceName  ) 

Set the instance name.

Definition at line 6798 of file OSOption.cpp.

bool OSOption::setInstanceLocation ( std::string  instanceLocation  ) 

Set the instance location.

Definition at line 6806 of file OSOption.cpp.

bool OSOption::setInstanceLocation ( std::string  instanceLocation,
std::string  locationType 
)

Alternative signature to set the instance location and location type simultaneously.

Definition at line 6816 of file OSOption.cpp.

bool OSOption::setInstanceLocationType ( std::string  locationType  ) 

Set the instance location type.

Definition at line 6830 of file OSOption.cpp.

bool OSOption::setJobID ( std::string  jobID  ) 

Set the job ID.

Definition at line 6852 of file OSOption.cpp.

bool OSOption::setSolverToInvoke ( std::string  solverToInvoke  ) 

Set the solver to be invoked.

Definition at line 6860 of file OSOption.cpp.

bool OSOption::setLicense ( std::string  license  ) 

Set the license information.

Definition at line 6868 of file OSOption.cpp.

bool OSOption::setUserName ( std::string  userName  ) 

Set the username.

Definition at line 6876 of file OSOption.cpp.

bool OSOption::setPassword ( std::string  password  ) 

Set the password.

Definition at line 6884 of file OSOption.cpp.

bool OSOption::setContact ( std::string  contact  ) 

Set the contact information.

Definition at line 6892 of file OSOption.cpp.

bool OSOption::setContact ( std::string  contact,
std::string  transportType 
)

Alternative signature to set the contact information and transport type simultaneously.

Definition at line 6902 of file OSOption.cpp.

bool OSOption::setContactTransportType ( std::string  transportType  ) 

Set the transport type for contact.

Definition at line 6916 of file OSOption.cpp.

bool OSOption::setOtherGeneralOptions ( int  numberOfOptions,
OtherOption **  other 
)

Set the other general options as an entire array.

Definition at line 6938 of file OSOption.cpp.

bool OSOption::setAnOtherGeneralOption ( std::string  name,
std::string  value,
std::string  description 
)

Add another general option to the general <other> option array.

Definition at line 6955 of file OSOption.cpp.

bool OSOption::setMinDiskSpace ( std::string  unit,
std::string  description,
double  value 
)

set() options in the <system> element

Definition at line 6970 of file OSOption.cpp.

bool OSOption::setMinDiskSpace ( double  value  ) 

Definition at line 6985 of file OSOption.cpp.

bool OSOption::setMinDiskSpaceUnit ( std::string  unit  ) 

Definition at line 6995 of file OSOption.cpp.

bool OSOption::setMinMemorySize ( std::string  unit,
std::string  description,
double  value 
)

Definition at line 7017 of file OSOption.cpp.

bool OSOption::setMinMemorySize ( double  value  ) 

Definition at line 7032 of file OSOption.cpp.

bool OSOption::setMinMemoryUnit ( std::string  unit  ) 

Definition at line 7042 of file OSOption.cpp.

bool OSOption::setMinCPUSpeed ( std::string  unit,
std::string  description,
double  value 
)

Definition at line 7074 of file OSOption.cpp.

bool OSOption::setMinCPUSpeed ( double  value  ) 

Definition at line 7064 of file OSOption.cpp.

bool OSOption::setMinCPUSpeedUnit ( std::string  unit  ) 

Definition at line 7089 of file OSOption.cpp.

bool OSOption::setMinCPUNumber ( int  number,
std::string  description 
)

Definition at line 7121 of file OSOption.cpp.

bool OSOption::setMinCPUNumber ( int  number  ) 

Definition at line 7111 of file OSOption.cpp.

bool OSOption::setOtherSystemOptions ( int  numberOfOptions,
OtherOption **  other 
)

Definition at line 7132 of file OSOption.cpp.

bool OSOption::setAnOtherSystemOption ( std::string  name,
std::string  value,
std::string  description 
)

Definition at line 7150 of file OSOption.cpp.

bool OSOption::setServiceType ( std::string  serviceType  ) 

set() options in the <service> element

Definition at line 7164 of file OSOption.cpp.

bool OSOption::setOtherServiceOptions ( int  numberOfOptions,
OtherOption **  other 
)

Definition at line 7184 of file OSOption.cpp.

bool OSOption::setAnOtherServiceOption ( std::string  name,
std::string  value,
std::string  description 
)

Definition at line 7201 of file OSOption.cpp.

bool OSOption::setMaxTime ( double  value,
std::string  unit 
)

Definition at line 7224 of file OSOption.cpp.

bool OSOption::setMaxTime ( double  value  ) 

set() options in the <job> element

Definition at line 7214 of file OSOption.cpp.

bool OSOption::setMaxTimeUnit ( std::string  unit  ) 

Definition at line 7238 of file OSOption.cpp.

bool OSOption::setRequestedStartTime ( std::string  time  ) 

Definition at line 7260 of file OSOption.cpp.

bool OSOption::setJobDependencies ( int  numberOfDependencies,
std::string *  jobDependencies 
)

Definition at line 7269 of file OSOption.cpp.

bool OSOption::setAnotherJobDependency ( std::string  jobID  ) 

Definition at line 7281 of file OSOption.cpp.

bool OSOption::setRequiredDirectories ( int  numberOfPaths,
std::string *  paths 
)

Definition at line 7291 of file OSOption.cpp.

bool OSOption::setAnotherRequiredDirectory ( std::string  path  ) 

Definition at line 7303 of file OSOption.cpp.

bool OSOption::setRequiredFiles ( int  numberOfPaths,
std::string *  paths 
)

Definition at line 7313 of file OSOption.cpp.

bool OSOption::setAnotherRequiredFile ( std::string  path  ) 

Definition at line 7325 of file OSOption.cpp.

bool OSOption::setDirectoriesToMake ( int  numberOfPaths,
std::string *  paths 
)

Definition at line 7335 of file OSOption.cpp.

bool OSOption::setAnotherDirectoryToMake ( std::string  path  ) 

Definition at line 7347 of file OSOption.cpp.

bool OSOption::setFilesToMake ( int  numberOfPaths,
std::string *  paths 
)

Definition at line 7357 of file OSOption.cpp.

bool OSOption::setAnotherFileToMake ( std::string  path  ) 

Definition at line 7369 of file OSOption.cpp.

bool OSOption::setPathPairs ( int  object,
std::string *  from,
std::string *  to,
bool *  makeCopy,
int  numberOfPathPairs 
)

setPathPairs set a number of path pairs into the OSOption object

Parameters:
object describes the type of pathpairs legal values are ENUM_PATHPAIR_input_dir, ENUM_PATHPAIR_input_file, ENUM_PATHPAIR_output_file, ENUM_PATHPAIR_output_dir
from is a pointer to an array of strings containing the location of the original object
to is a pointer to an array of strings containing the location of the destination object
makeCopy is a pointer to an array of boolean, describing for each object whether it is to be copied or moved
numberOfPathPairs is an integer giving the number of PathPairs this must equal the number of entries in the from, to and makeCopy arrays

Definition at line 7378 of file OSOption.cpp.

bool OSOption::setInputDirectoriesToMove ( int  numberOfPathPairs,
PathPair **  pathPair 
)

Definition at line 7416 of file OSOption.cpp.

bool OSOption::setAnotherInputDirectoryToMove ( std::string  fromPath,
std::string  toPath,
bool  makeCopy 
)

Definition at line 7428 of file OSOption.cpp.

bool OSOption::setInputFilesToMove ( int  numberOfPathPairs,
PathPair **  pathPair 
)

Definition at line 7438 of file OSOption.cpp.

bool OSOption::setAnotherInputFileToMove ( std::string  fromPath,
std::string  toPath,
bool  makeCopy 
)

Definition at line 7450 of file OSOption.cpp.

bool OSOption::setOutputFilesToMove ( int  numberOfPathPairs,
PathPair **  pathPair 
)

Definition at line 7460 of file OSOption.cpp.

bool OSOption::setAnotherOutputFileToMove ( std::string  fromPath,
std::string  toPath,
bool  makeCopy 
)

Definition at line 7472 of file OSOption.cpp.

bool OSOption::setOutputDirectoriesToMove ( int  numberOfPathPairs,
PathPair **  pathPair 
)

Definition at line 7482 of file OSOption.cpp.

bool OSOption::setAnotherOutputDirectoryToMove ( std::string  fromPath,
std::string  toPath,
bool  makeCopy 
)

Definition at line 7494 of file OSOption.cpp.

bool OSOption::setFilesToDelete ( int  numberOfPaths,
std::string *  paths 
)

Definition at line 7504 of file OSOption.cpp.

bool OSOption::setAnotherFileToDelete ( std::string  path  ) 

Definition at line 7516 of file OSOption.cpp.

bool OSOption::setDirectoriesToDelete ( int  numberOfPaths,
std::string *  paths 
)

Definition at line 7526 of file OSOption.cpp.

bool OSOption::setAnotherDirectoryToDelete ( std::string  path  ) 

Definition at line 7538 of file OSOption.cpp.

bool OSOption::setProcessesToKill ( int  numberOfProcesses,
std::string *  processes 
)

Definition at line 7548 of file OSOption.cpp.

bool OSOption::setAnotherProcessToKill ( std::string  process  ) 

Definition at line 7560 of file OSOption.cpp.

bool OSOption::setOtherJobOptions ( int  numberOfOptions,
OtherOption **  other 
)

Definition at line 7570 of file OSOption.cpp.

bool OSOption::setAnOtherJobOption ( std::string  name,
std::string  value,
std::string  description 
)

Definition at line 7587 of file OSOption.cpp.

bool OSOption::setNumberOfVariables ( int  numberOfVariables  ) 

Definition at line 7598 of file OSOption.cpp.

bool OSOption::setNumberOfObjectives ( int  numberOfObjectives  ) 

Definition at line 7606 of file OSOption.cpp.

bool OSOption::setNumberOfConstraints ( int  numberOfConstraints  ) 

Definition at line 7614 of file OSOption.cpp.

bool OSOption::setInitVarValues ( int  numberOfVar,
int *  idx,
double *  value,
std::string *  name 
)

Definition at line 7623 of file OSOption.cpp.

bool OSOption::setInitVarValuesSparse ( int  numberOfVar,
InitVarValue **  var 
)

Definition at line 7638 of file OSOption.cpp.

bool OSOption::setInitVarValuesDense ( int  numberOfVar,
double *  value 
)

Definition at line 7657 of file OSOption.cpp.

bool OSOption::setAnotherInitVarValue ( int  idx,
double  value 
)

Definition at line 7681 of file OSOption.cpp.

bool OSOption::setInitVarValuesString ( int  numberOfVar,
int *  idx,
std::string *  value,
std::string *  name 
)

Definition at line 7692 of file OSOption.cpp.

bool OSOption::setInitVarValuesStringSparse ( int  numberOfVar,
InitVarValueString **  var 
)

Definition at line 7706 of file OSOption.cpp.

bool OSOption::setInitVarValuesStringDense ( int  numberOfVar,
std::string *  value 
)

Definition at line 7725 of file OSOption.cpp.

bool OSOption::setAnotherInitVarValueString ( int  idx,
std::string  value 
)

Definition at line 7748 of file OSOption.cpp.

bool OSOption::setInitBasisStatus ( int  object,
int  status,
int *  i,
int  ni 
)

Definition at line 7759 of file OSOption.cpp.

bool OSOption::setInitBasisStatusSparse ( int  numberOfVar,
InitBasStatus **  var 
)
bool OSOption::setInitBasisStatusDense ( int  numberOfVar,
std::string *  var 
)
bool OSOption::setAnotherInitBasisStatus ( int  type,
int  idx,
int  status 
)

Set the basis status for another variable, objective or constraint/slack.

Parameters:
type,: type of this element (see ENUM_PROBLEM_COMPONENT - OSGeneral.h)
idx,: index of this element (nonnegative for variable or constraint, negative for objective)
status,: basis status (see ENUM_BASIS_STATUS - OSGeneral.h)

Definition at line 7810 of file OSOption.cpp.

bool OSOption::setIntegerVariableBranchingWeights ( int  numberOfVar,
int *  idx,
double *  value,
std::string *  name 
)

Definition at line 7848 of file OSOption.cpp.

bool OSOption::setIntegerVariableBranchingWeightsSparse ( int  numberOfVar,
BranchingWeight **  var 
)

Definition at line 7862 of file OSOption.cpp.

bool OSOption::setIntegerVariableBranchingWeightsDense ( int  numberOfVar,
double *  value 
)

Definition at line 7881 of file OSOption.cpp.

bool OSOption::setAnotherIntegerVariableBranchingWeight ( int  idx,
double  value 
)

Definition at line 7904 of file OSOption.cpp.

bool OSOption::setSOSVariableBranchingWeights ( int  numberOfSOS,
SOSWeights **  sos 
)

Definition at line 7916 of file OSOption.cpp.

bool OSOption::setAnotherSOSVariableBranchingWeight ( int  sosIdx,
int  nvar,
double  weight,
int *  idx,
double *  value,
std::string *  name 
)

Definition at line 7935 of file OSOption.cpp.

bool OSOption::setNumberOfOtherVariableOptions ( int  numberOfOther  ) 

Definition at line 7946 of file OSOption.cpp.

bool OSOption::setOtherVariableOptions ( int  numberOfVar,
OtherVariableOption **  var 
)

Definition at line 8086 of file OSOption.cpp.

bool OSOption::setAnOtherVariableOption ( OtherVariableOption varOption  ) 

Definition at line 8103 of file OSOption.cpp.

bool OSOption::setOtherVariableOptionAttributes ( int  iOther,
int  numberOfVar,
int  numberOfEnumerations,
std::string  name,
std::string  value,
std::string  solver,
std::string  category,
std::string  type,
std::string  description 
)

Set the attributes for one particular <other> <variable> option.

Parameters:
iOther,: position of this element in the array of <other>
numberOfVar,: number of children contained in this <other> element
numberOfEnumerations,: number of <enumeration> children
name,: name of this <other> element
value,: a value associated with this <other> element
solver,: the solver associated with this <other> element
category,: the category of this <other> element
type,: type of this <other> element
description,: further description of this <other> element

Definition at line 7966 of file OSOption.cpp.

bool OSOption::setOtherOptionEnumeration ( int  object,
int  otherOptionNumber,
int  enumerationNumber,
int  numberOfEl,
std::string  value,
std::string  description,
int *  idxArray 
)

Set one enumeration associated with an <other> option in the <variables>, <objectives> or <constraints> element.

Parameters:
object,: the object into which the enumeration is to be stored (legal values see ENUM_PROBLEM_COMPONENT in OSGeneral.h)
otherOptionNumber,: number of the <other> option in the list of <other> options (zero-based)
enumerationNumber,: number of the <enumeration> in the list of enumerations (zero-based)
numberOfEl,: number of objects sharing the value of this enumeration
value,: value of the enumeration (as a string)
description,: further information about the enumeration and its value
idxArray,: the array of indices for the objects sharing this enumeration

Definition at line 8004 of file OSOption.cpp.

bool OSOption::setOtherVariableOptionVar ( int  otherOptionNumber,
int  varNumber,
int  idx,
std::string  name,
std::string  value,
std::string  lbValue,
std::string  ubValue 
)

Set one element associated with an <other> option in the <variables> element.

Parameters:
otherOptionNumber,: number of the <other> option in the list of <other> options (zero-based)
varNumber,: number of the in the array (zero-based)
idx,: index of the variable to which this value belongs
value,: value of the option (as a string)
lbValue,: value associated with the lower bound of the variable (as a string)
ubValue,: value associated with the upper bound of the variable (as a string)

Definition at line 8062 of file OSOption.cpp.

bool OSOption::setInitObjValues ( int  numberOfObj,
int *  idx,
double *  value,
std::string *  name 
)

Definition at line 8112 of file OSOption.cpp.

bool OSOption::setInitObjValuesSparse ( int  numberOfObj,
InitObjValue **  obj 
)

Definition at line 8126 of file OSOption.cpp.

bool OSOption::setInitObjValuesDense ( int  numberOfObj,
double *  value 
)

Definition at line 8145 of file OSOption.cpp.

bool OSOption::setAnotherInitObjValue ( int  idx,
double  value 
)

Definition at line 8168 of file OSOption.cpp.

bool OSOption::setInitObjBounds ( int  numberOfObj,
int *  idx,
double *  lbValue,
double *  ubValue,
std::string *  name 
)

Definition at line 8179 of file OSOption.cpp.

bool OSOption::setInitObjBoundsSparse ( int  numberOfObj,
InitObjBound **  obj 
)

Definition at line 8193 of file OSOption.cpp.

bool OSOption::setInitObjBoundsDense ( int  numberOfObj,
double *  lb,
double *  ub 
)

Definition at line 8212 of file OSOption.cpp.

bool OSOption::setAnotherInitObjBound ( int  idx,
double  lbValue,
double  ubValue 
)

Definition at line 8234 of file OSOption.cpp.

bool OSOption::setNumberOfOtherObjectiveOptions ( int  numberOfOther  ) 

Definition at line 8268 of file OSOption.cpp.

bool OSOption::setOtherObjectiveOptions ( int  numberOfObj,
OtherObjectiveOption **  obj 
)

Definition at line 8325 of file OSOption.cpp.

bool OSOption::setAnOtherObjectiveOption ( OtherObjectiveOption objOption  ) 

Definition at line 8342 of file OSOption.cpp.

bool OSOption::setOtherObjectiveOptionAttributes ( int  iOther,
int  numberOfObj,
int  numberOfEnumerations,
std::string  name,
std::string  value,
std::string  solver,
std::string  category,
std::string  type,
std::string  description 
)

Set the attributes for one particular <other> <objective> option.

Parameters:
iOther,: position of this element in the array of <other>
numberOfObj,: number of <obj> children contained in this <other> element
numberOfEnumerations,: number of <enumeration> children
name,: name of this <other> element
value,: a value associated with this <other> element
solver,: the solver associated with this <other> element
category,: the category of this <other> element
type,: type of this <other> element
description,: further description of this <other> element

Definition at line 8288 of file OSOption.cpp.

bool OSOption::setOtherObjectiveOptionObj ( int  otherOptionNumber,
int  objNumber,
int  idx,
std::string  name,
std::string  value,
std::string  lbValue,
std::string  ubValue 
)

Set one <obj> element associated with an <other> option in the <objectives> element.

Parameters:
otherOptionNumber,: number of the <other> option in the list of <other> options (zero-based)
objNumber,: number of the <obj> in the array (zero-based)
idx,: index of the objective to which this value belongs
name,: name of the objective
value,: value of the option (as a string)
lbValue,: value associated with the lower bound of the objective (as a string)
ubValue,: value associated with the upper bound of the objective (as a string)

Definition at line 8245 of file OSOption.cpp.

bool OSOption::setInitConValues ( int  numberOfCon,
int *  idx,
double *  value,
std::string *  name 
)

Definition at line 8352 of file OSOption.cpp.

bool OSOption::setInitConValuesSparse ( int  numberOfCon,
InitConValue **  con 
)

Definition at line 8367 of file OSOption.cpp.

bool OSOption::setInitConValuesDense ( int  numberOfCon,
double *  value 
)

Definition at line 8386 of file OSOption.cpp.

bool OSOption::setAnotherInitConValue ( int  idx,
double  value 
)

Definition at line 8409 of file OSOption.cpp.

bool OSOption::setInitDualValues ( int  numberOfCon,
int *  idx,
double *  lbValue,
double *  ubValue,
std::string *  name 
)

Definition at line 8420 of file OSOption.cpp.

bool OSOption::setInitDualVarValuesSparse ( int  numberOfCon,
InitDualVarValue **  con 
)

Definition at line 8435 of file OSOption.cpp.

bool OSOption::setInitDualVarValuesDense ( int  numberOfCon,
double *  lb,
double *  ub 
)

Definition at line 8454 of file OSOption.cpp.

bool OSOption::setAnotherInitDualVarValue ( int  idx,
double  lbValue,
double  ubValue 
)

Definition at line 8477 of file OSOption.cpp.

bool OSOption::setNumberOfOtherConstraintOptions ( int  numberOfOther  ) 

Definition at line 8488 of file OSOption.cpp.

bool OSOption::setOtherConstraintOptions ( int  numberOfOptions,
OtherConstraintOption **  other 
)

Definition at line 8570 of file OSOption.cpp.

bool OSOption::setAnOtherConstraintOption ( OtherConstraintOption optionValue  ) 

Definition at line 8587 of file OSOption.cpp.

bool OSOption::setOtherConstraintOptionAttributes ( int  iOther,
int  numberOfCon,
int  numberOfEnumerations,
std::string  name,
std::string  value,
std::string  solver,
std::string  category,
std::string  type,
std::string  description 
)

Set the attributes for one particular <other> <constraint> option.

Parameters:
iOther,: position of this element in the array of <other>
numberOfCon,: number of <con> children contained in this <other> element
numberOfEnumerations,: number of <enumeration> children
name,: name of this <other> element
value,: a value associated with this <other> element
solver,: the solver associated with this <other> element
category,: the category of this <other> element
type,: type of this <other> element
description,: further description of this <other> element

Definition at line 8508 of file OSOption.cpp.

bool OSOption::setOtherConstraintOptionCon ( int  otherOptionNumber,
int  conNumber,
int  idx,
std::string  name,
std::string  value,
std::string  lbValue,
std::string  ubValue 
)

Set one <con> element associated with an <other> option in the <constraints> element.

Parameters:
otherOptionNumber,: number of the <other> option in the list of <other> options (zero-based)
conNumber,: number of the <obj> in the array (zero-based)
idx,: index of the constraint to which this value belongs
name,: name of the constraint
value,: value of the option (as a string)
lbValue,: value associated with the lower bound of the constraint (as a string)
ubValue,: value associated with the upper bound of the constraint (as a string)

Definition at line 8545 of file OSOption.cpp.

bool OSOption::setNumberOfSolverOptions ( int  numberOfOptions  ) 

Definition at line 8597 of file OSOption.cpp.

bool OSOption::setSolverOptionContent ( int  iOption,
int  numberOfItems,
std::string  name,
std::string  value,
std::string  solver,
std::string  category,
std::string  type,
std::string  description,
std::string *  itemList 
)

Set the attributes for one particular solver option.

Parameters:
iOption,: position of this element in the array of options
numberOfVar,: number of children contained in this <other> element
name,: name of this solver option
value,: a value associated with this option
solver,: the solver to which this option applies
category,: the category of this option (solver specific)
type,: type of this option (e.g., numeric or string)
description,: further description of this option param itemList: the list of items associated with this option (could be NULL)

Definition at line 8611 of file OSOption.cpp.

bool OSOption::setSolverOptions ( int  numberOfSolverOptions,
SolverOption **  solverOption 
)

Definition at line 8641 of file OSOption.cpp.

bool OSOption::setAnotherSolverOption ( std::string  name,
std::string  value,
std::string  solver,
std::string  category,
std::string  type,
std::string  description 
)

Definition at line 8658 of file OSOption.cpp.

bool OSOption::setOptionInt ( std::string  optionName,
int  optionValue 
)

Definition at line 8732 of file OSOption.cpp.

bool OSOption::setOptionStr ( std::string  optionName,
std::string  optionValue 
)

Definition at line 8669 of file OSOption.cpp.

bool OSOption::setOptionDbl ( std::string  optionName,
double  value 
)

Definition at line 8741 of file OSOption.cpp.


Member Data Documentation

OSOption has a header and five other children: general, system, service, job, and optimization.

header information

Definition at line 3109 of file OSOption.h.

generalOption holds the first child of the OSOption specified by the OSoL Schema.

Definition at line 3113 of file OSOption.h.

systemOption holds the second child of the OSOption specified by the OSoL Schema.

Definition at line 3117 of file OSOption.h.

serviceOption holds the third child of the OSOption specified by the OSoL Schema.

Definition at line 3121 of file OSOption.h.

jobOption holds the fourth child of the OSOption specified by the OSoL Schema.

Definition at line 3125 of file OSOption.h.

optimizationOption holds the fifth child of the OSOption specified by the OSoL Schema.

Definition at line 3129 of file OSOption.h.

m_mdInitVarValuesDense holds the initial variable values in dense form

Definition at line 3158 of file OSOption.h.

m_mdInitVarValuesStringDense holds the initial values for string-valued variables

Definition at line 3163 of file OSOption.h.

m_mdInitBasisStatusDense holds the initial basis status in dense form

Definition at line 3168 of file OSOption.h.

m_mdIntegerVariableBranchingWeightsDense holds the branching weights for integer variables

Definition at line 3173 of file OSOption.h.

m_mdInitObjValuesDense holds initial objective values in dense form

Definition at line 3178 of file OSOption.h.

m_mdInitObjLowerBoundsDense holds initial lower bounds for the objectives in dense form

Definition at line 3183 of file OSOption.h.

m_mdInitObjUpperBoundsDense holds initial upper bounds for the objectives in dense form

Definition at line 3188 of file OSOption.h.

m_mdInitConValuesDense holds initial constraint values in dense form

Definition at line 3193 of file OSOption.h.

m_mdInitDualVarLowerBoundsDense holds initial dual values for the lower bound of the constraints in dense form

Definition at line 3199 of file OSOption.h.

m_mdInitDualVarUpperBoundsDense holds initial dual values for the upper bound of the constraints in dense form

Definition at line 3205 of file OSOption.h.


The documentation for this class was generated from the following files:

Generated on 22 May 2012 by  doxygen 1.6.1