Documentation

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.

getdose (model)

Return SimBiology dose object

Syntax

doseObj = getdose(modelObj)
doseObj = getdose(modelObj, 'DoseName')

Arguments

modelObjSelects a model object that contains a dose object.
DoseNameName of a dose object contained in a model object. DoseName is from the dose object property, Name.

Outputs

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

Description

doseObj = getdose(modelObj) returns a Simbiology dose object (doseObj) contained in a Simbiology model object (modelObj).

doseObj = getdose(modelObj, 'DoseName') returns a SimBiology® dose object (modelObj) with the name DoseName.

Examples

Get a dose object from a model object.

  1. Create a model object, and then add a dose object to the model object.

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

  2. Get the dose object from a model object.

    myModelDose = getdose(modelObj);
    

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

Was this topic helpful?