SimBiology.export.Dose class

Superclasses: matlab.mixin.Heterogeneous

Exported SimBiology model dose object

Description

SimBiology.export.Dose is the superclass for modifiable export dose objects. An export dose is either of subclass SimBiology.export.RepeatDose or SimBiology.export.ScheduleDose.

Construction

Export dose objects are created by the export method for SimBiology® models. By default, all active doses are export doses, but you can specify which doses to export using the optional editdoses input argument to export.

export (model)Export SimBiology models for deployment and standalone applications

Properties

Amount

Amount of dose, a nonnegative scalar value. This property is read-only if it is parameterized in the export model.

AmountUnits

Dose amount units. This property is read-only.

DurationParameterName

Parameter specifying length of time to administer a dose. This property is read-only.

EventMode

Determine how events that change dose parameters affect in-progress dosing. This property is read-only.

LagParameterName

Parameter specifying time lag for the dose. This property is read-only.

Name

Name of dose object. This property is read-only.

Notes

Text describing dose object. This property is read-only.

Parent

Name of the parent export model. This property is read-only.

Rate

Rate of dose, a nonnegative scalar value. The default value is 0 (RepeatDose) or [] (ScheduleDose), that is, the dose is interpreted as a bolus (instantaneous) dose. This property is read-only if it is parameterized in the export model.

RateUnits

Units for dose rate. This property is read-only.

TargetName

Species receiving dose. This property is read-only.

TimeUnits

Time units for dosing. This property is read-only.

Copy Semantics

Handle. To learn how handle classes affect copy operations, see Copying Objects (MATLAB).

Examples

collapse all

Open a sample SimBiology model project, and export the included model object.

sbioloadproject('AntibacterialPKPD')
em = export(m1);

Get the editable doses from the exported model object.

doses = getdose(em)
doses=1×4 object
  1x4 RepeatDose array with properties:

    Interval
    RepeatCount
    StartTime
    TimeUnits
    Amount
    AmountUnits
    DurationParameterName
    LagParameterName
    Name
    Notes
    Parent
    Rate
    RateUnits
    TargetName

The exported model has 4 repeated dose objects.

Display the 3rd dose object from the exported model object.

doses(3)
ans = 
  RepeatDose with properties:

                 Interval: 12
              RepeatCount: 27
                StartTime: 0
                TimeUnits: 'hour'
                   Amount: 500
              AmountUnits: 'milligram'
    DurationParameterName: 'TDose'
         LagParameterName: ''
                     Name: '500 mg bid'
                    Notes: ''
                   Parent: 'Antibacterial'
                     Rate: 0
                RateUnits: ''
               TargetName: 'Central.Drug'

Change the dosing amount for this dose object.

doses(3).Amount = 600;
doses(3)
ans = 
  RepeatDose with properties:

                 Interval: 12
              RepeatCount: 27
                StartTime: 0
                TimeUnits: 'hour'
                   Amount: 600
              AmountUnits: 'milligram'
    DurationParameterName: 'TDose'
         LagParameterName: ''
                     Name: '500 mg bid'
                    Notes: ''
                   Parent: 'Antibacterial'
                     Rate: 0
                RateUnits: ''
               TargetName: 'Central.Drug'