Amount

Amount of dose

The Amount property of a ScheduleDose object is a column vector instead of a row vector. For details, see Compatibility Considerations.

Description

Amount is a property of a RepeatDose or ScheduleDose object. It defines an increase in the amount of a SimBiology species that receives a dose.

A RepeatDose object defines a series of doses. Each dose is the same amount, as defined by the Amount property, and given at equally spaced times, as defined by the Interval property.

The number of injections in the series, excluding the initial injection, is defined by the RepeatCount property, and the Rate property defines how fast each dose is given.

For RepeatDose objects, you can parameterize the property by setting it to the name of a model-scoped parameter that is not being modified by a repeated assignment rule, an algebraic rule, or a rate rule. However, the parameter can be modified by an event.

A ScheduleDose object defines a series of doses. Each dose can have a different amount, as defined by an amount array in the Amount property, and given at specified times, as defined by a time array in the Time property. A rate array in the Rate property defines how fast each dose is given. At each time point in the time array, a dose is given with the corresponding amount and rate.

Characteristics

Applies to	Object: `RepeatDose`, `ScheduleDose`.
Data type	double or character vector (`RepeatDose`) or double coulmn (`ScheduleDose`).
Data values	Nonnegative value or name of a model-scoped parameter object. The default value is `0` (`RepeatDose`) or `0x1` empty double column vector (`ScheduleDose`).
Access	Read/write.

Version History

expand all

R2019b: `Amount` property of `ScheduleDose` is a column vector

The Amount property of a ScheduleDose object is a column vector instead of a row vector. The default value is 0x1 empty double column vector, instead of [].