SimBiology^®

sbiomodel - Construct model object

Syntax

modelObj = sbiomodel('NameValue') modelObj = sbiomodel(...'PropertyName', PropertyValue...)

Arguments

`NameValue`	Required property to specify a unique name for a `model` object. Enter a character string.
`PropertyName`	Property name for a `Model` object from the Property Summary table below.
`PropertyValue`	Property value. Valid value for the specified property.

Description

modelObj = sbiomodel('NameValue') creates a model object and returns the model object (modelObj). In the model object, this method assigns a value (NameValue) to the property Name.

modelObj = sbiomodel(...'PropertyName', PropertyValue...) defines optional properties. The property name and property value pairs can be in any format supported by the function set (for example, name-value string pairs, structures, and name-value cell array pairs).

Simulate modelObj with the function sbiosimulate.

Add objects to a model object using the methods addkineticlaw, addmodel, addparameter, addreaction, addrule, and addspecies.

All SimBiology^® model objects can be retrieved from the SimBiology root object. A SimBiology model object has its Parent property set to the SimBiology root object.

Method Summary

addcompartment (model, compartment)	Create compartment object
addconfigset (model)	Create configuration set object and add to model object
addevent (model)	Add event object to model object
addparameter (model, kineticlaw)	Create parameter object and add to model or kinetic law object
addreaction (model)	Create reaction object and add to model object
addrule (model)	Create rule object and add to model object
addvariant (model)	Add variant to model
copyobj (any object)	Copy SimBiology^® object and its children
delete (any object)	Delete SimBiology^® object
display (any object)	Display summary of SimBiology^® object
getadjacencymatrix (model)	Get adjacency matrix from model object
getconfigset (model)	Get configuration set object from model object
getstoichmatrix (model)	Get stoichiometry matrix from model object
getvariant (model)	Get variant from model
removeconfigset (model)	Remove configuration set from model
removevariant (model)	Remove variant from model
reorder (model, compartment)	Reorder component lists
setactiveconfigset (model)	Set active configuration set for model object
verify (model, variant)	Validate and verify SimBiology^® model

Property Summary

Annotation	Store link to URL or file
Compartments	Array of compartments in model or compartment
Events	Contain all event objects
Models	Contain all model objects
Name	Specify name of object
Notes	HTML text describing SimBiology^® object
Parameters	Array of parameter objects
Parent	Indicate parent object
Reactions	Array of reaction objects
Rules	Array of rules in model object
Tag	Specify label for SimBiology^® object
Type	Display top-level SimBiology^® object type
UserData	Specify data to associate with object

Examples

Create a SimBiology model object.

modelObj = sbiomodel('cell', 'Tag', 'mymodel');

List all modelObj properties and the current values.

get(modelObj)

MATLAB returns

    Annotation: ''
        Models: [0x1 double]
          Name: 'cell'
         Notes: ''
    Parameters: [0x1 double]
        Parent: [1x1 SimBiology.Root]
       Species: [0x1 double]
     Reactions: [0x1 double]
         Rules: [0x1 double]
           Tag: 'mymodel'
          Type: 'sbiomodel'
      UserData: []

Display summary of modelObj contents.

modelObj

  SimBiology Model - cell 

   Model Components:
     Models:            0
     Parameters:        0
     Reactions:         0
     Rules:             0
     Species:           0