Main Content

SimBiology.export.RepeatDose Properties

Repeated doses for exported SimBiology model

SimBiology.export.RepeatDose is the object property for export repeat doses.

Export repeat dose properties are created by the export function 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 Repeat Dose

expand all

Amount of dose, specified as 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.

This property is read-only.

Dose amount units, specified as a character vector.

This property is read-only.

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

This property is read-only.

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

Time between doses, specified as 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.

This property is read-only.

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

This property is read-only.

Name of dose object, specified as a character vector.

This property is read-only.

Text describing dose object, specified as a character vector.

This property is read-only.

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

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

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.

This property is read-only.

Units for dose rate, specified as a character vector.

Dose repetitions, specified as 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.

Start time for initial dose, specified as 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.

This property is read-only.

Species receiving dose, specified as a character vector.

This property is read-only.

Time units for dosing, specified as a character vector.

Version History

Introduced in R2012b