sbiomodel

Construct model object

Syntax

modelObj = sbiomodel(modelName)

modelObj = sbiomodel(modelName,Name=Value)

Description

modelObj = sbiomodel(modelName) returns a SimBiology^® model object and sets its Name property to modelName.

modelObj = sbiomodel(modelName,Name=Value) also sets the properties of the model object using one or more name-value arguments. Name is the property name and Value is the corresponding value.

Examples

collapse all

Create SimBiology Model

Open Live Script

Create a SimBiology model object, named m1.

modelObj = sbiomodel("m1");

Add a reaction to the model.

r1 = addreaction(modelObj,"A -> B");

List all modelObj properties and the current values.

get(modelObj)

ans = struct with fields:
    Compartments: [1x1 SimBiology.Compartment]
         Species: [2x1 SimBiology.Species]
      Parameters: [0x1 SimBiology.Parameter]
           Rules: [0x1 SimBiology.Rule]
          Events: [0x1 SimBiology.Event]
     Observables: [0x1 SimBiology.Observable]
       Reactions: [1x1 SimBiology.Reaction]
            Name: 'm1'
          Parent: [1x1 SimBiology.Root]
           Notes: ''
             Tag: ''
            Type: 'sbiomodel'
        UserData: []

Display a summary of modelObj contents.

modelObj

modelObj = 
   SimBiology Model - m1 

   Model Components:
     Compartments:      1
     Events:            0
     Parameters:        0
     Reactions:         1
     Rules:             0
     Species:           2
     Observables:       0

Input Arguments

collapse all

`modelName` — Name of SimBiology model

Name of the SimBiology model, specified as a character vector or string scalar.

Data Types: char | string

Output Arguments

collapse all

`modelObj` — SimBiology model
`SimBiology.Model`

SimBiolgy model, returned as a Model object.

All SimBiology model objects can be retrieved from the SimBiology root object (see sbioroot). A SimBiology model object has its Parent property set to the SimBiology root object.