ScheduleDose object

Define drug dosing protocol

Description

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

Each dose can have a different amount, as defined by an amount array in the Amount property. Each dose can be 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.

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.

When there are multiple active ScheduleDdose objects on a model, and there are duplicate specifications for a property value, the simulation uses the last occurrence for the property value in the array of doses. You can find out which dose youapplied last by looking at the indices of the dose objects stored on the model.

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

Constructor Summary

sbiodoseConstruct dose object

Method Summary

Methods for variant 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 variant objects

ActiveIndicate object in use during simulation
AmountAmount of dose
AmountUnitsDose amount units
DurationParameterNameParameter specifying length of time to administer a dose
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
TagSpecify label for SimBiology object
TargetNameSpecies receiving dose
TimeSimulation time steps or schedule dose times
TimeUnitsShow time units for dosing and simulation
TypeDisplay SimBiology object type
UserDataSpecify data to associate with object
Was this topic helpful?