SimulationTask | R Documentation |
R6 class for SimulationTask settings
ospsuite.reportingengine::Task
-> SimulationTask
getTaskResults
function called by task that computes and format figure results
settings
instance of SimulationSettings class
nameTaskResults
name of function that returns task results
ospsuite.reportingengine::Task$activate()
ospsuite.reportingengine::Task$getAbsolutePath()
ospsuite.reportingengine::Task$getInputs()
ospsuite.reportingengine::Task$getRelativePath()
ospsuite.reportingengine::Task$inactivate()
ospsuite.reportingengine::Task$print()
ospsuite.reportingengine::Task$validateInput()
ospsuite.reportingengine::Task$validateStructureSetInput()
new()
Create a SimulationTask
object
SimulationTask$new( getTaskResults = NULL, settings = NULL, nameTaskResults = "none", ... )
getTaskResults
function called by task that computes and format figure results
settings
instance of SimulationSettings class
nameTaskResults
name of function that returns task results
...
parameters inherited from R6 class Task
object
A new SimulationTask
object
saveResults()
Save results from task run.
SimulationTask$saveResults(set, taskResults)
set
R6 class SimulationStructure
taskResults
list of results from task run.
runTask()
Run task and save its output
SimulationTask$runTask(structureSets)
structureSets
list of SimulationStructure
R6 class
clone()
The objects of this class are cloneable with this method.
SimulationTask$clone(deep = FALSE)
deep
Whether to make a deep clone.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.