Formula: Formula

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

Formula

Description

A formula of the model (Typically related to a Quantity such as a parameter)

A table formula of the model (Typically related to a Quantity such as a parameter)

Super classes

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

Active bindings

isTable

Is this a table formula (Read-Only)

isTableWithOffSet

Is this a table formula with Offset (Read-Only)

isTableWithXArgument

Is this a table formula with xArgs (typically time, or pH) (Read-Only)

isConstant

Is this a constant formula (Read-Only)

isExplicit

Is this an explicit formula (Read-Only)

isDistributed

Is this a distributed formula (Read-Only)

dimension

The dimension in which the quantity is defined (Read-Only)

formulaString

Returns the formula as a string for an ExplicitFormula or NULL otherwise (Read-Only).

Methods

Public methods

• Formula$print()

• Formula$printFormula()

Inherited methods

• rSharp::NetObject$call()
• rSharp::NetObject$finalize()
• 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()
• ospsuite::DotNetWrapper$initialize()

---

Method print()

Print the object to the console

Usage

Formula$print(...)

Arguments

...

Rest arguments.

---

Method printFormula()

Print the formula to the console without the name of the class

Usage

Formula$printFormula()

Super classes

rSharp::NetObject -> ospsuite::DotNetWrapper -> ospsuite::ObjectBase -> ospsuite::Formula -> TableFormula

Active bindings

allPoints

Returns all points defined in the table formula for a TableFormula or NULL otherwise (Read-Only).

useDerivedValues

Indicates whether table values should be derived during solving. the ODE system. Default value is TRUE

xDimension

The dimension in which the x values are defined (Read-Only).

Methods

Public methods

• TableFormula$addPoints()

• TableFormula$removePoint()

• TableFormula$clearPoints()

• TableFormula$setPoints()

• TableFormula$print()

• TableFormula$valueAt()

• TableFormula$printFormula()

Inherited methods

• rSharp::NetObject$call()
• rSharp::NetObject$finalize()
• 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()
• ospsuite::DotNetWrapper$initialize()

---

Method addPoints()

Adds one or more points to a table

Usage

TableFormula$addPoints(xValues, yValues)

Arguments

xValues

x values (single value or array) in base unit for XDimension

yValues

y values (single value or array) in base unit for Dimension

---

Method removePoint()

Remove the point having the same x and y from the table

Usage

TableFormula$removePoint(xValue, yValue)

Arguments

xValue

xValue value in base unit for XDimension

yValue

yValue value in base unit for Dimension

---

Method clearPoints()

Remove all points from the table

Usage

TableFormula$clearPoints()

---

Method setPoints()

Replace all points defined in the table with the new values given. This is a convenience method for calling clearPoints and addPoints

Usage

TableFormula$setPoints(xValues, yValues)

Arguments

xValues

x values (single value or array) in base unit for XDimension

yValues

y values (single value or array) in base unit for Dimension

---

Method print()

Print the object to the console

Usage

TableFormula$print(...)

Arguments

...

Rest arguments.

---

Method valueAt()

Returns the y defined for the x value in base unit. If not exact match is found, value will be interpolated between two existing points If the table contains no point, 0 is returned

Usage

TableFormula$valueAt(xValue)

Arguments

xValue

x value for in base unit for which the yValue should be returned

---

Method printFormula()

Print the formula to the console

Usage

TableFormula$printFormula()

Open-Systems-Pharmacology/OSPSuite-R documentation built on Feb. 14, 2025, 4:48 p.m.