Main Content

SimBiology.export.RepeatDose class

Superclasses: SimBiology.export.Dose

Repeated doses for exported SimBiology model

Description

SimBiology.export.RepeatDose is the class for export repeat doses.

Construction

Export repeat dose objects are created by the export method for SimBiology® models. By default, all active repeat doses are export repeat doses, but you can specify which repeat 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 or the name (character vector) of a model-scoped parameter. This property is read-only if it is parameterized in the export model.

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.

Interval

Time between doses, a nonnegative scalar value or the name of a model-scoped parameter. This property is read-only if it is parameterized in the export model.

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 or the name (string or character vector) of a model-scoped parameter. This property is read-only if it is parameterized in the export model. The default value is 0, that is, the dose is interpreted as a bolus (instantaneous) dose.

RateUnits

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

RepeatCount

Dose repetitions, a nonnegative integer value or the name (string or character vector) of a model-scoped parameter. This property is read-only if it is parameterized in the export model.

StartTime

Start time for initial dose, a nonnegative scalar value or the name (string or character vector) of a model-scoped parameter. This property is read-only if it is parameterized in the export model.

TargetName

Species receiving dose. This property is read-only.

TimeUnits

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

Note

You cannot change the Rate property of RepeatDose 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.