SnapshotParameter: SnapshotParameter

In Open-Systems-Pharmacology/OSPSuite-R: R package to manipulate OSPSuite Models

SnapshotParameter

Description

A parameter typically used in the definition of IndividualCharacteristics covariates (Height, Weight etc...)

Super classes

rSharp::NetObject -> ospsuite::DotNetWrapper -> SnapshotParameter

Active bindings

value

Parameter value

unit

Unit in which the value is defined

Methods

Public methods

• SnapshotParameter$new()

• SnapshotParameter$print()

• SnapshotParameter$printValue()

• SnapshotParameter$getPrintValue()

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

SnapshotParameter$new(netObject = NULL, value = NULL, unit = NULL)

Arguments

netObject

Optional NetObject. If not defined, a new instance will be created

value

Optional value of the parameter.

unit

Optional unit of the value specified.

Returns

A new SnapshotParameter object.

---

Method print()

Print the object to the console

Usage

SnapshotParameter$print(...)

Arguments

...

Rest arguments.

---

Method printValue()

Print the parameter in one line

Usage

SnapshotParameter$printValue(caption)

Arguments

caption

Caption to display before the value of the parameter

---

Method getPrintValue()

Return a string for printing the parameter in one line

Usage

SnapshotParameter$getPrintValue()

Returns

A string for printing the parameter in one line

Open-Systems-Pharmacology/OSPSuite-R documentation built on June 10, 2025, 6:54 a.m.