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 vector or string.
PropertyName	Property name for a Model object from Property Summary.
PropertyValue	Property value. Valid value for the specified property.

Description

modelObj = sbiomodel('NameValue') creates and returns a SimBiology^® 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 name-value pairs can be in any format supported by the function set.

Simulate modelObj with the function sbiosimulate.

Add objects to a model object using the methods addkineticlaw, 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
adddose (model)	Add dose object to model
addevent (model)	Add event object to model object
addobservable	Add observable object to SimBiology model
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
addspecies (model, compartment)	Create species object and add to compartment object within model object
addvariant (model)	Add variant to model
copyobj	Copy SimBiology object and its children
createSimFunction (model)	Create SimFunction object
delete	Delete SimBiology object
display	Display summary of SimBiology object
export (model)	Export SimBiology models for deployment and standalone applications
findUnusedComponents (model)	Find unused species, parameters, and compartments in a model
get	Get SimBiology object properties
getadjacencymatrix (model)	Get adjacency matrix from model object
getconfigset (model)	Get configuration set object from model object
getdose (model)	Return SimBiology dose object
getequations	Return system of equations for model object
getstoichmatrix (model)	Get stoichiometry matrix from model object
getvariant (model)	Get variant from model
removeconfigset (model)	Remove configuration set from model
removedose (model)	Remove dose object from model
removevariant (model)	Remove variant from model
rename	Rename object and update expressions
reorder (model, compartment, kinetic law)	Reorder component lists
set	Set SimBiology object properties
setactiveconfigset (model)	Set active configuration set for model object
verify (model, variant)	Validate and verify SimBiology model

Property Summary

Compartments	Array of compartments in model or compartment
Events	Contain all event objects
Name	Specify name of object
Notes	HTML text describing SimBiology object
Observables	Array of observable objects
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 SimBiology object type
UserData	Specify data to associate with object

Examples

1. Create a SimBiology model object.

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

2. 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: []

3. Display a summary of modelObj contents.

   modelObj

     SimBiology Model - cell 
   
      Model Components:
        Models:            0
        Parameters:        0
        Reactions:         0
        Rules:             0
        Species:           0

Version History

Introduced in R2006a