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.
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 variant 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.
|sbiodose||Construct dose object|
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|
Properties for RepeatDose objects
|Active||Indicate object in use during simulation|
|Amount||Amount of dose|
|AmountUnits||Dose amount units|
|DurationParameterName||Parameter specifying length of time to administer a dose|
|Interval||Time between doses|
|LagParameterName||Parameter specifying time lag for dose|
|Name||Specify name of object|
|Notes||HTML text describing SimBiology object|
|Parent||Indicate parent object|
|Rate||Rate of dose|
|RateUnits||Units for dose rate|
|StartTime||Start time for initial dose time|
|Tag||Specify label for SimBiology object|
|TargetName||Species receiving dose|
|TimeUnits||Show time units for dosing and simulation|
|Type||Display SimBiology object type|
|UserData||Specify data to associate with object|