SimulationRunOptions

Options to be passed to the simulation engine

Super classes

rSharp::NetObject -> DotNetWrapper -> SimulationRunOptions

Active bindings

numberOfCores

(Maximal) number of cores to be used. Work is distributed across cores both when several simulations are passed to runSimulations() in one call and when simulating a population (where individuals are split across cores). It has no effect on a single individual simulation. Default is getOSPSuiteSetting("numberOfCores").

showProgress

Specifies whether a progress bar should be shown during population simulations. If TRUE, a progress bar is shown in the console, indicating the number of already executed simulations from the total population size. The progress bar does not indicate the progress of a single simulation. This option only applies to population simulations and has no effect on individual simulations. Default is getOSPSuiteSetting("showProgress")

Methods

Public methods

• SimulationRunOptions$new()

• SimulationRunOptions$print()

Inherited methods

• rSharp::NetObject$.printClass()
• rSharp::NetObject$.printLine()
• rSharp::NetObject$call()
• rSharp::NetObject$get()
• rSharp::NetObject$getFields()
• rSharp::NetObject$getMemberSignature()
• rSharp::NetObject$getMethods()
• rSharp::NetObject$getProperties()
• rSharp::NetObject$getStaticFields()
• rSharp::NetObject$getStaticMethods()
• rSharp::NetObject$getStaticProperties()
• rSharp::NetObject$set()

---

SimulationRunOptions$new()

Initialize a new instance of the class

Usage

SimulationRunOptions$new(
  numberOfCores = NULL,
  checkForNegativeValues = NULL,
  showProgress = NULL
)

Arguments

numberOfCores

Number of cores to use for the simulation. Default value is getOSPSuiteSetting("numberOfCores")

checkForNegativeValues

Use sim$solver$checkForNegativeValues instead.

showProgress

Should a progress bar be displayed during population simulations. If TRUE, a progress bar is shown in the console, indicating the number of already executed simulations from the total population size. The progress bar does not indicate the progress of a single simulation. This option only applies to population simulations and has no effect on individual simulations. Default value is getOSPSuiteSetting("showProgress")

Returns

A new SimulationRunOptions object.

---

SimulationRunOptions$print()

Print the object to the console

Usage

SimulationRunOptions$print(...)

Arguments

...

Rest arguments.