An object storing configuration of a specific scenario
Super class
ospsuite.utils::Printable
-> ScenarioConfiguration
Public fields
scenarioName
Name of the simulated scenario
modelFile
Name of the simulation to be loaded (must include the extension ".pkml"). Must be located in the "modelFolder".
applicationProtocol
Name of the application protocol to be applied. Defined in the excel file "Applications.xlsx"
individualId
Id of the individual as specified in "Individuals.xlsx". If
NULL
(default), the individual as defined in the simulation file will be simulated.populationId
Id of the population as specified in "Populations.xlsx", sheet "Demographics". If
ScenarioConfguration$simulationType
ispopulation
, a population will be created a the scenario will be simulated as a population simulation.outputPaths
a list of output paths for which the results will be calculated. If
NULL
(default), outputs as defined in the simulation are used.
Active bindings
simulateSteadyState
Boolean representing whether the simulation will be brought to a steady-state first
readPopulationFromCSV
Boolean representing whether the a new population will be created (value is
FALSE
) or an existing population will be imported from a csv.simulationTime
Specified simulation time intervals. If
NULL
(default), simulation time as defined in theSimulation
object will be used. Accepted are multiple time intervals separated by a ';'. Each time interval is a triplet of values <StartTime, EndTime, Resolution>, whereResolution
is the number of simulated points per time unit defined in the columnTimeUnit
.simulationTimeUnit
Unit of the simulation time intervals.
steadyStateTime
Time in minutes to simulate if simulating steady-state. May be
NULL
.paramSheets
Names of the sheets from the parameters-excel file that will be applied to the simulation
simulationType
Type of the simulation - "Individual" or "Population". If "Population", population characteristics are created based on information stored in
populationsFile
. Default is "Individual"projectConfiguration
ProjectConfiguration
that will be used in scenarios. Read-only
Methods
Method new()
Initialize a new instance of the class
Usage
ScenarioConfiguration$new(projectConfiguration)
Method addParamSheets()
Add the names of sheets in the parameters excel-file that will be applied to the simulation
Method removeParamSheets()
Remove the names of sheets in the parameters excel-file
from the list of sheets paramSheets
Method print()
Print the object to the console