rneos (version 0.4-0)

NeosXml-class: Class "NeosXml"

Description

Objects of this class contain the returned results from NEOS as well as information on which kind of query has been sent and how it was sent.

Objects from the Class

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

Slots

xml:

Object of class "XMLNode": The returned and converted XML-template of NEOS.

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 = "NeosXml"): Returns the converted slot xml from an object of class NeosXml.

References

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

See Also

'>NeosComm

Examples

# NOT RUN {
showClass("NeosXml")
# }
# 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)
NgetJobInfo(obj = test, convert = TRUE)
NgetFinalResults(obj = test, convert = TRUE)
# }