An interface that specified virtual methods to be implemented by agents.
More...
#include "OShL.h"
|
| 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
|
|
An interface that specified virtual methods to be implemented by agents.
This is a virtual class that lists all of the methods a client (or scheduler/solver) should implement
Definition at line 32 of file OShL.h.
◆ OShL()
Default constructor.
Definition at line 19 of file OShL.cpp.
◆ ~OShL()
Class destructor.
Definition at line 22 of file OShL.cpp.
◆ solve()
virtual std::string OShL::solve |
( |
std::string | osil, |
|
|
std::string | osol ) |
|
pure virtual |
submit an instance with its options for a synchronous solution
- Parameters
-
osil | is the string with the instance in OSiL format |
osol | is the string with the options in OSoL format |
- Returns
- a string which is the result in OSrL format.
Implemented in OSSolverAgent.
◆ getJobID()
virtual std::string OShL::getJobID |
( |
std::string | osol | ) |
|
|
pure virtual |
get a jobID for use in the send method
- Parameters
-
osol | is the string with the options in OSoL format |
- Returns
- a string which is the jobID
Implemented in OSSolverAgent.
◆ send()
virtual bool OShL::send |
( |
std::string | osil, |
|
|
std::string | osol ) |
|
pure virtual |
submit an instance with its options for an asynchronous solution
- 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 successfully submitted
Implemented in OSSolverAgent.
◆ kill()
virtual std::string OShL::kill |
( |
std::string | osol | ) |
|
|
pure virtual |
kill an instance that is running
- Parameters
-
osol | is the string with the options in OSoL format |
- Returns
- a string which is in OSpL format
Implemented in OSSolverAgent.
◆ retrieve()
virtual std::string OShL::retrieve |
( |
std::string | osol | ) |
|
|
pure virtual |
retrieve an instance result that ran in asynchronous mode
- 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
Implemented in OSSolverAgent.
◆ knock()
virtual std::string OShL::knock |
( |
std::string | ospl, |
|
|
std::string | osol ) |
|
pure virtual |
knock to get information on the current status of a job
- 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.
Implemented in OSSolverAgent.
The documentation for this class was generated from the following files:
- /builddir/build/BUILD/coin-or-OS-2.10.3-build/OS-releases-2.10.3/OS/src/OSAgent/OShL.h
- /builddir/build/BUILD/coin-or-OS-2.10.3-build/OS-releases-2.10.3/OS/src/OSAgent/OShL.cpp