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...

Private Attributes
std::string	solverAddress
	solverAddress is the URI for the solver More...

unsigned short	solverPortNumber
	solverPortNumber is the port number for the solver More...

std::string	postURI
	postURI is the path to the solver that follows the first '/' in the solverAddress 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:

solve
kill
send
retrieve
knock
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

Definition at line 43 of file OSSolverAgent.cpp.

OSSolverAgent::~OSSolverAgent ( )

Class destructor.

Definition at line 68 of file OSSolverAgent.cpp.

Member Function Documentation

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.

Definition at line 72 of file OSSolverAgent.cpp.

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.

Definition at line 252 of file OSSolverAgent.cpp.

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.

Definition at line 174 of file OSSolverAgent.cpp.

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.

Definition at line 392 of file OSSolverAgent.cpp.

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.

Definition at line 320 of file OSSolverAgent.cpp.

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.

Definition at line 458 of file OSSolverAgent.cpp.

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

Definition at line 156 of file OSSolverAgent.cpp.

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 solver

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:

/tmp/OS-2.10.2/OS/src/OSAgent/OSSolverAgent.h
/tmp/OS-2.10.2/OS/src/OSAgent/OSSolverAgent.cpp

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation