adddose (model) - Add dose object to model

Syntax

Arguments

modelObj	Model object to which you add a dose object.
DoseName	Name of a dose object to construct and add to a model object. DoseName is the value of the dose object property Name.
DoseType	Type of dose object to construct and add to a model object. Enter either 'schedule' or 'repeat'.
doseObj	Dose object to add to a model object. Created with the constructor sbiodose.

Outputs

doseObj2

ScheduleDose or RepeatDose object. A RepeatDose or ScheduleDose object defines an increase (dose) to a species amount during a simulation.

Description

Before using a dose object in a simulation, use the adddose method to add the dose object to a SimBiology model object. Then, set the Active dose object property to true.

doseObj2 = adddose(modelObj, 'DoseName') constructs a SimBiology RepeatDose object (doseObj2), assigns DoseName to the property Name, adds the dose object to a SimBiology model object (modelObj), and assigns modelObj to the property Parent.

doseObj2 = adddose(modelObj, 'DoseName', 'DoseType') constructs either a SimBiology ScheduleDose object or RepeatDose object (doseObj).

doseObj2 = adddose(modelObj, doseObj) adds a SimBiology dose object (doseObj) to a SimBiology model object (modelObj), copies the dose object to a second dose object (doseObj2), and assigns modelObj to the property Parent.

Example

Add a dose object to a model object.

1. Create a model then add a dose to the model.

   modelObj = sbiomodel('mymodel');
   dose1Obj = adddose(modelObj, 'dose1');
   

2. Define properties of the dose object.

   dose1Obj.Amount = 5'
   dose1Obj.Repeat = 6;
   dose1obj.Interval = 24;
   dose1Obj.TImeUnits = 'hour'

See Also

Model object methods:

• adddose — add a dose object to a model object

• getdose — get dose information from a model object

• removedose — remove a dose object from a model object

Dose object constructor sbiodose.

ScheduleDose object and RepeatDose object methods:

• copyobj — copy a dose object from one model object to another model object

• get — view properties for a dose object

• set — define or modify properties for a dose object

© 1984-2012- The MathWorks, Inc.    -   Site Help   -   Patents   -   Trademarks   -   Privacy Policy   -   Preventing Piracy   -   RSS