OS  2.9.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Member Functions | List of all members
OSSolverAgent Class Reference

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

#include "OSSolverAgent.h"

+ Inheritance diagram for OSSolverAgent:
+ Collaboration diagram for OSSolverAgent:

Public Member Functions

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

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
solverURIis the location of remote solver or scheduler
OSSolverAgent::~OSSolverAgent ( )

Class destructor.

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
osila string that holds the problem instance
osolis a string of options for the solver
Returns
osrl which is a string with the result.

Implements OShL.

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

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

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

Implements OShL.

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

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

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

Implements OShL.

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

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

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

Implements OShL.

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

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

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

Implements OShL.

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

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

Parameters
osplis the string with the process information in OSpL format
osolis the string with the options in OSoL format
Returns
a string which is the knock result in OSpL format.

Implements OShL.

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

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

Parameters
osilFileNameis the name of the file with the OSiL instance to be written on the server
osilis a string with the OSiL problem instance

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