MoBi Module

A MoBi module, either loaded from a project or from a pkml file

Value

A named list of BuildingBlock objects, with names being the names of the PV BBs.

A named list of BuildingBlock objects, with names being the names of the IC BBs.

A MoleculesBuildingBlock object exposing molecule-name queries (e.g. allMoleculeNames(), allMoleculeNamesOfType(), moleculeTypeFor()), or NULL if the module has no Molecules BB.

Super classes

rSharp::NetObject -> ospsuite::DotNetWrapper -> ospsuite::ObjectBase -> MoBiModule

Active bindings

name

Name of the module (read-only)

isPKSimModule

Whether the module is a PK-Sim module (read-only)

mergeBehavior

Merge behavior of the module. Must be one of "Extend" or "Overwrite".

parameterValuesBBnames

Names of the Parameter Values Building Blocks (PV BBs) in the module (read-only)

initialConditionsBBnames

Names of the Initial Conditions Building Blocks (IC BBs) in the module (read-only)

Methods

Public methods

• MoBiModule$new()

• MoBiModule$getParameterValuesBBs()

• MoBiModule$getInitialConditionsBBs()

• MoBiModule$getMoleculesBB()

• MoBiModule$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()

---

Method new()

Initialize a new instance of the class

Usage

MoBiModule$new(netObject)

Arguments

netObject

Reference to NetObject .NET MoBi-module object

Returns

A new MoBiModule object.

---

Method getParameterValuesBBs()

Get the list of Parameter Values Building Blocks (PV BBs) in the module.

Usage

MoBiModule$getParameterValuesBBs(names = NULL, stopIfNotFound = TRUE)

Arguments

names

Optional names of the Parameter Values Building Block to retrieve. If NULL, returns all PV BBs.

stopIfNotFound

If TRUE (default), an error is thrown if any of the specified parameter values BB is not present in the project.

---

Method getInitialConditionsBBs()

Get the list of Initial Conditions Building Blocks (IC BBs) in the module.

Usage

MoBiModule$getInitialConditionsBBs(names = NULL, stopIfNotFound = TRUE)

Arguments

names

Optional names of the Initial Conditions Building Block to retrieve. If NULL, returns all IC BBs.

stopIfNotFound

If TRUE (default), an error is thrown if any of the specified initial conditions BB is not present in the project.

---

Method getMoleculesBB()

Get the Molecules Building Block of the module, if any.

Usage

MoBiModule$getMoleculesBB()

---

Method print()

Print the object to the console

Usage

MoBiModule$print(printClassProperties = FALSE, ...)

Arguments

printClassProperties

Logical, whether to print class properties (default: FALSE). If TRUE, calls first the print method of the parent class. Useful for debugging.

...

Rest arguments.