SimBiology.export.Model class

Superclasses:

Exported SimBiology model object

expand all in page

Description

Exported SimBiology® models are limited-access models that can be simulated and accelerated. You can speedup simulation of exported models using Parallel Computing Toolbox™, and deploy exported models using MATLAB® Compiler™.

By default, all active dose objects, species, parameters, and compartments export with a SimBiology model, and are editable in the exported model object. You can limit which doses, species, parameters, and compartments are editable using additional options during export. Reactions, rules, and events are never editable in an exported model.

Construction

Use the export method to export a SimBiology model.

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

Properties

DependentFiles

Function files the model depends on. This property is read only.

ExportNotes

Text with additional information associated with the exported model. This property is read only.

ExportTime

Creation time of the exported model. This property is read only.

InitialValues

Vector of initial values for modifiable species, compartments, and parameters.

Name

Name of the exported model. This property is read only.

Notes

HTML text describing the exported model object. This property is read only.

SimulationOptions

SimBiology.export.SimulationOptions object specifying simulation options.

ValueInfo

Array of SimBiology.export.ValueInfo objects of modifiable species, parameters, and compartments.

Methods

acceleratePrepare exported SimBiology model for acceleration
getIndexGet indices into ValueInfo and InitialValues properties
getdoseReturn exported SimBiology model dose object
isAcceleratedDetermine whether an exported SimBiology model is accelerated
simulateSimulate exported SimBiology model

Copy Semantics

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

Examples

collapse all

Open Live Script

Load a sample SimBiology model object, and export. 

modelObj = sbmlimport('lotka');
em = export(modelObj)
em = 
  Model with properties:

           Name: 'lotka'
     ExportTime: '18-Aug-2020 09:03:01'
    ExportNotes: ''

Display the editable values (compartments, species, and parameters) information. 

em.ValueInfo
ans=8×1 object
  8x1 ValueInfo array with properties:

    Constant
    InitialValue
    Name
    Parent
    QualifiedName
    Tag
    Type
    Units

There are 8 editable values. Display the names of the editable values. 

{em.ValueInfo.Name}
ans = 1x8 cell
  Columns 1 through 7

    {'unnamed'}    {'x'}    {'y1'}    {'y2'}    {'z'}    {'c1'}    {'c2'}

  Column 8

    {'c3'}

Display the exported model simulation options. 

em.SimulationOptions
ans = 
  ODESimulationOptions with properties:

            AbsoluteTolerance: 1.0000e-06
     AbsoluteToleranceScaling: 1
    AbsoluteToleranceStepSize: [0x1 double]
                      MaxStep: [0x1 double]
                  OutputTimes: [0x1 double]
            RelativeTolerance: 1.0000e-03
                   SolverType: 'ode15s'
          MaximumNumberOfLogs: Inf
             MaximumWallClock: Inf
                     StopTime: 10
                    TimeUnits: 'second'

See Also

| | |

Topics

SimBiology Documentation

Support