mtkSystemEvaluator-class: The 'mtkSystemEvaluator' class
In mtk: Mexico ToolKit library (MTK)

Description Class Hierarchy Constructor Slots Methods Author(s) References Examples

The mtkSystemEvaluator class is a sub-class of the class mtkEvaluator used to manage the simulation of the model implemented as a system application.

Parent classes :: mtkEvaluator
Direct Known Subclasses :

mtkSystemEvaluator: signature( service="",mtkParameters=NULL,listParameters = NULL)

name:: (character) always takes the string "evaluate".
protocol:: (character) always takes the string "system".
site:: (character) not used here.
service:: (character) a string to invoke the system command implementing the model.
parameters:: (vector) a vector of [mtkParameter] containing the parameters to pass while invoking the system command.
ready:: (logical) a logical to tell if the process is ready to run.
state:: (logical) a logical to tell if the results produced by the process are available and ready to be consumed.
result:: (ANY) a data holder to hold the results produced by the process

setName: signature(this = "mtkSystemEvaluator", name = "character"): Not used, method inherited from the parent class.
setParameters: signature(this = "mtkSystemEvaluator", f = "vector"): Assigns new parameters to the process.
getParameters: signature(this = "mtkSystemEvaluator"): Returns the parameters as a named list.
is.ready: signature( = "mtkSystemEvaluator"): Tests if the process is ready to run.
setReady: signature(this = "mtkSystemEvaluator", switch = "logical"): Makes the process ready to run.
is.ready: signature( = "mtkSystemEvaluator"): Tests if the results produced by the process are available.
setReady: signature(this = "mtkSystemEvaluator", switch = "logical"): Marks the process as already executed.
getResult: signature(this = "mtkSystemEvaluator"): Returns the results produced by the process as a [mtkEvaluatorResult].
getData: signature(this = "mtkSystemEvaluator"): Returns the results produced by the process as a data.frame.
serializeOn: signature(this = "mtkSystemEvaluator"): Returns all data managed by the process as a named list.
run: signature(this = "mtkSystemEvaluator", context= "mtkExpWorkflow"): runs the simulation.
summary: signature(object = "mtkSystemEvaluator"): Provides a summary of the results produced by the process.
print: signature(x = "mtkSystemEvaluator"): Prints a report of the results produced by the process.
plot: signature(x = "mtkSystemEvaluator"): Plots the results produced by the process.
report: signature(this = "mtkSystemEvaluator"): Reports the results produced by the process.

Juhui WANG, MIA-Jouy, Inra, Juhui.Wang@jouy.inra.fr

J. Wang, H. Richard, R. Faivre, H. Monod (2013). Le package mtk, une bibliothèque R pour l'exploration numérique des modèles. In: Analyse de sensibilité et exploration de modèles : Application aux sciences de la nature et de l'environnement (R. Faivre, B. Iooss, S. Mahévas, D. Makowski, H. Monod, Eds). Editions Quae, Versailles.