NgetJobStatus {rneos}

XML-RPC method getJobStatus of Neos

Description

This functions calls the XML-RPC method “getJobStatus()” of NEOS and returns an object of class NeosAns. The functions returns the current job status (either “Done”, “Running”, “Waiting”, “Unknown Job” or “Bad Password”).

Usage

NgetJobStatus(obj, convert = TRUE)

Arguments

obj

NeosJob, an object of class NeosJob as returned by the function NsubmitJob.

convert

Logical, if convert = TRUE (the default) the value of the returned XML-RPC result is extracted and returned as character, otherwise the XML-RPC string is returned.

Value

An object of class NeosAns.

Author(s)

Bernhard Pfaff

References

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

See Also

NeosAns and NsubmitJob

Examples

## 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)
test <- NsubmitJob(xmlstring = xmls, user = "rneos", interface = "",
id = 0)
NgetJobStatus(obj = test, convert = TRUE)

## End(Not run)