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.
	~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
Public Member Functions inherited from OShL
	OShL ()
	Default constructor.
virtual	~OShL ()=0
	Class destructor.
virtual std::string	solve (std::string osil, std::string osol)=0
	submit an instance with its options for a synchronous solution
virtual std::string	getJobID (std::string osol)=0
	get a jobID for use in the send method
virtual bool	send (std::string osil, std::string osol)=0
	submit an instance with its options for an asynchronous solution
virtual std::string	kill (std::string osol)=0
	kill an instance that is running
virtual std::string	retrieve (std::string osol)=0
	retrieve an instance result that ran in asynchronous mode
virtual std::string	knock (std::string ospl, std::string osol)=0
	knock to get information on the current status of a job

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::OSSolverAgent

(

std::string

solverURI

)

Default constructor.

Parameters

solverURI

is the location of remote solver or scheduler

~OSSolverAgent()

OSSolverAgent::~OSSolverAgent

(

)

Class destructor.

Member Function Documentation

solve()

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.

getJobID()

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.

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.

kill()

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.

retrieve()

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.

knock()

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.

fileUpload()

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

---

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

• /builddir/build/BUILD/OS-2.10.2/src/OSAgent/OSSolverAgent.h