SimBiology.export.ScheduleDose Properties

Schedule dose for exported SimBiology model

SimBiology.export.ScheduleDose is the object property for export schedule doses.

Export schedule dose properties are created by the export function for SimBiology^® models. By default, all active schedule doses are export schedule doses, but you can specify which schedule doses to export using the optional editdoses input argument to export.

Export Schedule Dose

Amount — Amount of dose

nonnegative scalar

Amount of dose, specified as a nonnegative scalar value.

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

empty array (default) | nonnegative scalar

Rate of dose, specified as a nonnegative scalar value. Default is [], that is, the dose is interpreted as a bolus (instantaneous) dose. For a schedule dose, you can create a combination of bolus and infusion doses by setting the rate property to a vector containing zeros and non-zeros.

Note

You cannot change the Rate property of ScheduleDose for exported SimBiology model if all of the following conditions are true:

• The UnitConversion property of the model is already set to true.

• The Rate property is empty or set to zero.

• The RateUnits is set to empty.

To change the Rate, do one of the following:

• Set the UnitConversion property of the original model to false. Then export the model again.

• Set the RateUnits appropriately.

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.

Time — Schedule dose times

vector of nonnegative values

Schedule dose times, specified as a vector of nonnegative values.

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