NeosJob-class: Class "NeosJob"

In rneos: XML-RPC Interface to NEOS

Description

Objects of this class contain among other slots the returned jobnumber and password for jobs submitted to NEOS. Objects of this class can then be used for retrieving the optimization results.

Objects from the Class

Objects can be created by calls of the form new("NeosJob", ...) or more conveniently by calling the relevant R API function NsubmitJob.

Slots

jobnumber:

Object of class "numeric": The returned job number.

password:

Object of class "character": The returned pass word.

method:

Object of class "character": The name of the called API function.

call:

Object of class "call": The call to the generating function of the object.

nc:

Object of class "NeosComm": The NeosComm object that has been used in the request to NEOS.

Methods

show

signature(object = "NeosJob"): Displays the slots jobnumber and password from an object of class NeosJob.

Author(s)

Bernhard Pfaff

References

NEOS API: https://neos-server.org/neos/xml-rpc.html

Examples

showClass("NeosJob")
## Not run: 
tmp <-NgetSolverTemplate(category = "go", solvername = "ASA",
inputMethod = "AMPL")
## setting path to example model and data file
modf <- system.file("ExAMPL", "diet.mod", package = "rneos")
datf <- system.file("ExAMPL", "diet.dat", package = "rneos")
## import of file contents
modc <- paste(paste(readLines(modf), collapse = "\n"), "\n")
datc <- paste(paste(readLines(datf), collapse = "\n"), "\n")
## create list object
argslist <- list(model = modc, data = datc, commands = "",
comments = "")
## create XML string
xmls <- CreateXmlString(neosxml = tmp, cdatalist = argslist)
NsubmitJob(xmlstring = xmls, user = "rneos", interface = "", id = 0)

## End(Not run)

rneos documentation built on April 23, 2020, 9:05 a.m.