SimBiology.export.Dose Properties

Exported SimBiology model dose object

SimBiology.export.Dose is the object property for modifiable export dose objects. An export dose is either of object type SimBiology.export.RepeatDose or SimBiology.export.ScheduleDose.

Export dose objects are created by the export function for SimBiology^® models. By default, all active doses are export doses, but you can specify which doses to export using the optional editdoses input argument to export. For example, see Exported SimBiology Model Dose Objects.

Export Dose

Amount — Amount of dose

nonnegative scalar

Amount of dose, specified as a nonnegative scalar value. This property is read-only if it is parameterized in the export model.

AmountUnits — Dose amount units

Read-only: character vector

This property is read-only.

Dose amount units, specified as a character vector.

DurationParameterName — Parameter specifying length of time to administer a dose

Read-only: character vector

This property is read-only.

Parameter specifying length of time to administer a dose, specified as a character vector.

EventMode — Determine how events that change dose parameters affect in-progress dosing

Read-only: 'stop' (default) | 'continue'

This property is read-only.

Determine how events that change dose parameters affect in-progress dosing, specified as 'stop' or 'continue'.

LagParameterName — Parameter specifying time lag for the dose

Read-only: character vector

This property is read-only.

Parameter specifying time lag for the dose, specified as a character vector.

Name — Name of dose object

Read-only: character vector

This property is read-only.

Name of dose object, specified as a character vector.

Notes — Text describing dose object

Read-only: character vector

This property is read-only.

Text describing dose object, specified as a character vector.

Parent — Name of the parent export model

Read-only: SimBiology component object | empty array

This property is read-only.

Name of the parent export model, specified as a SimBiology component object or an empty array.

Rate — Rate of dose

nonnegative scalar

Rate of dose, specified as a nonnegative scalar value. The default value is 0 (RepeatDose) or [] (ScheduleDose), that is, the dose is interpreted as a bolus (instantaneous) dose. This property is read-only if it is parameterized in the export model.

RateUnits — Units for dose rate

Read-only: character vector

This property is read-only.

Units for dose rate, specified as a character vector.

TargetName — Species receiving dose

Read-only: character vector

This property is read-only.

Species receiving dose, specified as a character vector.

TimeUnits — Time units for dosing

Read-only: character vector

This property is read-only.

Time units for dosing, specified as a character vector.

Version History

Introduced in R2012b