SimBiology.export.ScheduleDose class

Superclasses: SimBiology.export.Dose

Schedule dose for exported SimBiology model

Description

SimBiology.export.ScheduleDose is the class for export schedule doses.

Construction

Export schedule dose objects are created by the export method 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 (model)Export SimBiology models for deployment and standalone applications

Properties

Amount

Amount of dose, a nonnegative scalar value.

AmountUnits

Dose amount units. This property is read-only.

DurationParameterName

Parameter specifying length of time to administer a dose. This property is read-only.

EventMode

Determine how events that change dose parameters affect in-progress dosing. This property is read-only.

LagParameterName

Parameter specifying time lag for the dose. This property is read-only.

Name

Name of dose object. This property is read-only.

Notes

Text describing dose object. This property is read-only.

Parent

Name of the parent export model. This property is read-only.

Rate

Rate of dose, 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.

RateUnits

Units for dose rate. This property is read-only.

TargetName

Species receiving dose. This property is read-only.

Time

Schedule dose times, a vector of nonnegative values.

TimeUnits

Time units for dosing. This property is read-only.

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.

Copy Semantics

Handle. To learn how handle classes affect copy operations, see Copying Objects.