This is machine translation

Translated by Microsoft
Mouseover text to see original. Click the button below to return to the English verison of the page.

Note: This page has been translated by MathWorks. Please click here
To view all translated materals including this page, select Japan from the country navigator on the bottom of this page.

RepeatDose object

Define drug dosing protocol


A RepeatDose object defines a series of doses to the amount of a species during a simulation. The TargetName property of a dose object defines the species that receives the dose.

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 RepeatCount property defines the number of injections in the series, excluding the initial injection. The Rate property defines how fast each dose is given.

To use a dose object in a simulation you must add the dose object to a model object and set the Active property of the dose object to true. Set the Active property to true if you always want the dose to be applied before simulating the model.

    Warning:   The Active property of the RepeatDose object will be removed in a future release. Explicitly specify a dose or an array of doses as an input argument when you simulate a model using sbiosimulate.

When there are multiple active RepeatDose objects on a model and if there are duplicate specifications for a property value, the last occurrence for the property value in the array of dose, is used during simulation. You can find out which dose is applied last by looking at the indices of the dose objects stored on the model.

See Property Summary for links to species property reference pages. Properties define the characteristics of an object. Use the get and set commands to list object properties and change their values at the command line. You can graphically change object properties in the graphical user interface.

Constructor Summary

Method Summary

Methods for RepeatDose objects

copyobj (any object)Copy SimBiology object and its children
get (any object)Get object properties
getTable(ScheduleDose,RepeatDose)Return data from SimBiology dose object as table
set (any object)Set object properties
setTable(ScheduleDose,RepeatDose)Set dosing information from table to dose object

Property Summary

Properties for RepeatDose objects

ActiveIndicate object in use during simulation
AmountAmount of dose
AmountUnitsDose amount units
DurationParameterNameParameter specifying length of time to administer a dose
IntervalTime between doses
LagParameterNameParameter specifying time lag for dose
NameSpecify name of object
NotesHTML text describing SimBiology object
ParentIndicate parent object
RateRate of dose
RateUnitsUnits for dose rate
RepeatCountDose repetitions
StartTimeStart time for initial dose time
TagSpecify label for SimBiology object
TargetNameSpecies receiving dose
TimeUnitsShow time units for dosing and simulation
TypeDisplay SimBiology object type
UserDataSpecify data to associate with object

Introduced in R2010a

Was this topic helpful?