OSSolverAgent Class Reference

Used by a client to invoke a remote solver. More...

#include <OSSolverAgent.h>

Inheritance diagram for OSSolverAgent:

Inheritance graph
[legend]
Collaboration diagram for OSSolverAgent:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 OSSolverAgent (std::string solverURI)
 Default constructor.
 ~OSSolverAgent ()
 Class destructor.
std::string solve (std::string osil, std::string osol)
 implement the solve() method which is a virtual function in OShL, this is synchronous
std::string getJobID (std::string osol)
 implement the getJobID() method which is a virtual function in OShL
bool send (std::string osil, std::string osol)
 implement the send() method which is a virtual function in OShL
std::string kill (std::string osol)
 implement the kill() method which is a virtual function in OShL
std::string retrieve (std::string osol)
 implement the retrieve() method which is a virtual function in OShL
std::string knock (std::string ospl, std::string osol)
 implement the knock() method which is a virtual function in OShL
std::string fileUpload (std::string osilFileName, std::string osil)
 implement the fileUpload() method which is a virtual function in OShL

Private Attributes

std::string solverAddress
 solverAddress is the URI for the solver
unsigned short solverPortNumber
 solverPortNumber is the port number for the sovler
std::string postURI
 postURI is the path to the solver that follows the first / in the solverAddress

Detailed Description

Used by a client to invoke a remote solver.

Remarks:
This is an implementation of the virtual class OShL. We need to implement the following virtual methods.

The following key methods are invoked:

  1. solve
  2. kill
  3. send
  4. retrieve
  5. knock
  6. getJobID

Definition at line 41 of file OSSolverAgent.h.


Constructor & Destructor Documentation

OSSolverAgent::OSSolverAgent ( std::string  solverURI  ) 

Default constructor.

Parameters:
solverURI is the location of remote solver or scheduler

OSSolverAgent::~OSSolverAgent (  ) 

Class destructor.

Definition at line 64 of file OSSolverAgent.cpp.


Member Function Documentation

std::string OSSolverAgent::solve ( std::string  osil,
std::string  osol 
) [virtual]

implement the solve() method which is a virtual function in OShL, this is synchronous

Parameters:
osil a string that holds the problem instance
osol is a string of options for the solver
Returns:
osrl which is a string with the result.

Implements OShL.

Referenced by main(), solve(), and OSMatlab::solve().

std::string OSSolverAgent::getJobID ( std::string  osol  )  [virtual]

implement the getJobID() method which is a virtual function in OShL

Parameters:
osol is the string with the options in OSoL format
Returns:
a string which is the jobID

Implements OShL.

Referenced by getJobID(), main(), and send().

bool OSSolverAgent::send ( std::string  osil,
std::string  osol 
) [virtual]

implement the send() method which is a virtual function in OShL

Parameters:
osil is the string with the instance in OSiL format
osol is the string with the options in OSoL format
Returns:
a bool which is true if the job is successfuly submitted

Implements OShL.

Referenced by main(), and send().

std::string OSSolverAgent::kill ( std::string  osol  )  [virtual]

implement the kill() method which is a virtual function in OShL

Parameters:
osol is the string with the options in OSoL format
Returns:
a string which is in OSpL format

Implements OShL.

Referenced by kill(), and main().

std::string OSSolverAgent::retrieve ( std::string  osol  )  [virtual]

implement the retrieve() method which is a virtual function in OShL

Parameters:
osol is the string with the options in OSoL format
Returns:
a string which is in the result of the optimization is OSrL fomrat

Implements OShL.

Referenced by main(), and retrieve().

std::string OSSolverAgent::knock ( std::string  ospl,
std::string  osol 
) [virtual]

implement the knock() method which is a virtual function in OShL

Parameters:
ospl is the string with the process information in OSpL format
osol is the string with the options in OSoL format
Returns:
a string which is the knock result in OSpL format.

Implements OShL.

Referenced by knock(), and main().

std::string OSSolverAgent::fileUpload ( std::string  osilFileName,
std::string  osil 
)

implement the fileUpload() method which is a virtual function in OShL

Parameters:
osilFileName is the name of the file with the OSiL instance to be written on the server
osil is a string with the OSiL problem instance

Referenced by main().


Member Data Documentation

std::string OSSolverAgent::solverAddress [private]

solverAddress is the URI for the solver

Definition at line 133 of file OSSolverAgent.h.

unsigned short OSSolverAgent::solverPortNumber [private]

solverPortNumber is the port number for the sovler

Definition at line 136 of file OSSolverAgent.h.

std::string OSSolverAgent::postURI [private]

postURI is the path to the solver that follows the first / in the solverAddress

Definition at line 141 of file OSSolverAgent.h.


The documentation for this class was generated from the following files:
Generated on Thu Sep 22 03:13:56 2011 by  doxygen 1.4.7