NgetJobStatus: XML-RPC method getJobStatus of Neos

Description Usage Arguments Value Author(s) References See Also Examples

View source: R/NgetJobStatus.R

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

1
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: http://neos-guide.org/content/NEOS-API,
Omegahat web site for RCurl: http://www.omegahat.net/RCurl,
Omegahat web site for XMLRPC: http://www.omegahat.net/XMLRPC

See Also

NeosAns and NsubmitJob

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
## 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)

rneos documentation built on May 31, 2017, 3:11 a.m.

Related to NgetJobStatus in rneos...