Skip to contents

An optimized simulation with faster loading. The corresponding .NET class is "OSPSuite.R.Services.ConcurrentRunSimulationBatch"

Super classes

ospsuite.utils::Printable -> ospsuite::DotNetWrapper -> SimulationBatch

Active bindings

simulation

Underlying simulation used for the batch run. Read only.

runValuesIds

Ids of the run values that will be executed on next run

Methods

Inherited methods


    Method new()

    Initialize a new instance of the class

    Usage

    SimulationBatch$new(ref, simulation)

    Arguments

    ref

    .NET reference object.

    simulation

    Simulation used in the batch run

    Returns

    A new SimulationBatch object.


    Method addRunValues()

    Add a set of parameter and start values for next execution.

    Usage

    SimulationBatch$addRunValues(parameterValues = NULL, initialValues = NULL)

    Arguments

    parameterValues

    Vector of parameter values to set in the simulation (default is NULL)

    initialValues

    Vector of initial values to set in the simulation (default is NULL)

    Details

    Intended for the use with runSimulationBatches. The simulation batch is executed with the sets of parameter and initial values that have been scheduled. The set of run values is cleared after successful run.

    Returns

    Id of the values set that can be used to get the correct result from runSimulationBatches.

    Examples

    \dontrun{
    sim1 <- loadSimulation("sim1", loadFromCache = TRUE)
    sim2 <- loadSimulation("sim2", loadFromCache = TRUE)
    parameters <- c("Organism|Liver|Volume", "R1|k1")
    molecules <- "Organism|Liver|A"
    # Create two simulation batches.
    simulationBatch1 <- createSimulationBatch(simulation = sim1,
    parametersOrPaths = parameters,
    moleculesOrPaths = molecules)
    simulationBatch2 <- createSimulationBatch(simulation = sim2,
    parametersOrPaths = parameters,
    moleculesOrPaths = molecules)
    #Ids of run values
    ids <- c()
    ids[[1]] <- simulationBatch1$addRunValues(parameterValues = c(1, 2), initialValues = 1)
    ids[[2]] <- simulationBatch1$addRunValues(parameterValues = c(1.6, 2.4), initialValues = 3)
    ids[[3]] <- simulationBatch2$addRunValues(parameterValues = c(4, 2), initialValues = 4)
    ids[[4]] <- simulationBatch2$addRunValues(parameterValues = c(2.6, 4.4), initialValues = 5)
    res <- runSimulationBatches(simulationBatches = list(simulationBatch1, simulationBatch2))
    }
    


    Method print()

    Print the object to the console

    Usage

    SimulationBatch$print(...)

    Arguments

    ...

    Additional arguments.

    Examples

    
    ## ------------------------------------------------
    ## Method `SimulationBatch$addRunValues`
    ## ------------------------------------------------
    
    # \dontrun{
    sim1 <- loadSimulation("sim1", loadFromCache = TRUE)
    #> Error in rClr::clrCall(simulationPersister, "LoadSimulation", expandPath(filePath),     resetIds): Type:    System.IO.FileNotFoundException
    #> Message: Could not find file 'C:\Users\IndrajeetPatil\Documents\GitHub\OSPSuite-R\docs\reference\sim1'.
    #> Method:  Void WinIOError(Int32, System.String)
    #> Stack trace:
    #>    at System.IO.__Error.WinIOError(Int32 errorCode, String maybeFullPath)
    #>    at System.IO.FileStream.Init(String path, FileMode mode, FileAccess access, Int32 rights, Boolean useRights, FileShare share, Int32 bufferSize, FileOptions options, SECURITY_ATTRIBUTES secAttrs, String msgPath, Boolean bFromProxy, Boolean useLongPath, Boolean checkHost)
    #>    at System.IO.FileStream..ctor(String path, FileMode mode, FileAccess access, FileShare share, Int32 bufferSize)
    #>    at System.Xml.XmlDownloadManager.GetStream(Uri uri, ICredentials credentials, IWebProxy proxy, RequestCachePolicy cachePolicy)
    #>    at System.Xml.XmlUrlResolver.GetEntity(Uri absoluteUri, String role, Type ofObjectToReturn)
    #>    at System.Xml.XmlTextReaderImpl.FinishInitUriString()
    #>    at System.Xml.XmlReaderSettings.CreateReader(S
    sim2 <- loadSimulation("sim2", loadFromCache = TRUE)
    #> Error in rClr::clrCall(simulationPersister, "LoadSimulation", expandPath(filePath),     resetIds): Type:    System.IO.FileNotFoundException
    #> Message: Could not find file 'C:\Users\IndrajeetPatil\Documents\GitHub\OSPSuite-R\docs\reference\sim2'.
    #> Method:  Void WinIOError(Int32, System.String)
    #> Stack trace:
    #>    at System.IO.__Error.WinIOError(Int32 errorCode, String maybeFullPath)
    #>    at System.IO.FileStream.Init(String path, FileMode mode, FileAccess access, Int32 rights, Boolean useRights, FileShare share, Int32 bufferSize, FileOptions options, SECURITY_ATTRIBUTES secAttrs, String msgPath, Boolean bFromProxy, Boolean useLongPath, Boolean checkHost)
    #>    at System.IO.FileStream..ctor(String path, FileMode mode, FileAccess access, FileShare share, Int32 bufferSize)
    #>    at System.Xml.XmlDownloadManager.GetStream(Uri uri, ICredentials credentials, IWebProxy proxy, RequestCachePolicy cachePolicy)
    #>    at System.Xml.XmlUrlResolver.GetEntity(Uri absoluteUri, String role, Type ofObjectToReturn)
    #>    at System.Xml.XmlTextReaderImpl.FinishInitUriString()
    #>    at System.Xml.XmlReaderSettings.CreateReader(S
    parameters <- c("Organism|Liver|Volume", "R1|k1")
    molecules <- "Organism|Liver|A"
    # Create two simulation batches.
    simulationBatch1 <- createSimulationBatch(simulation = sim1,
    parametersOrPaths = parameters,
    moleculesOrPaths = molecules)
    #> Error in isOfType(object, type, nullAllowed): object 'sim1' not found
    simulationBatch2 <- createSimulationBatch(simulation = sim2,
    parametersOrPaths = parameters,
    moleculesOrPaths = molecules)
    #> Error in isOfType(object, type, nullAllowed): object 'sim2' not found
    #Ids of run values
    ids <- c()
    ids[[1]] <- simulationBatch1$addRunValues(parameterValues = c(1, 2), initialValues = 1)
    #> Error in eval(expr, envir, enclos): object 'simulationBatch1' not found
    ids[[2]] <- simulationBatch1$addRunValues(parameterValues = c(1.6, 2.4), initialValues = 3)
    #> Error in eval(expr, envir, enclos): object 'simulationBatch1' not found
    ids[[3]] <- simulationBatch2$addRunValues(parameterValues = c(4, 2), initialValues = 4)
    #> Error in eval(expr, envir, enclos): object 'simulationBatch2' not found
    ids[[4]] <- simulationBatch2$addRunValues(parameterValues = c(2.6, 4.4), initialValues = 5)
    #> Error in eval(expr, envir, enclos): object 'simulationBatch2' not found
    res <- runSimulationBatches(simulationBatches = list(simulationBatch1, simulationBatch2))
    #> Error in isOfType(object, type, nullAllowed): object 'simulationBatch1' not found
    # }