Documentation Center

  • Trial Software
  • Product Updates

sbiomodel

Construct model object

Syntax

modelObj = sbiomodel('NameValue')

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

Arguments

NameValueRequired property to specify a unique name for a model object. Enter a character string.
PropertyNameProperty name for a Model object from Property Summary.
PropertyValueProperty 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/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, 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
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 (any object)Copy SimBiology object and its children
createSimFunction (model)Create SimFunction object
delete (any object)Delete SimBiology object
display (any object)Display summary of SimBiology object
export (model)Export SimBiology models for deployment and standalone applications
get (any object)Get 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
getstoichmatrix (model)Get stoichiometry matrix from model object
getvariant (model)Get variant from model
getequationsReturn system equations for model object
removeconfigset (model)Remove configuration set from model
removedose (model)Add dose object to model
removevariant (model)Remove variant from model
reorder (model, compartment, kinetic law)Reorder component lists
set (any object)Set object properties
setactiveconfigset (model)Set active configuration set for model object
verify (model, variant)Validate and verify SimBiology model

Property Summary

CompartmentsArray of compartments in model or compartment
EventsContain all event objects
NameSpecify name of object
NotesHTML text describing SimBiology object
ParametersArray of parameter objects
ParentIndicate parent object
ReactionsArray of reaction objects
RulesArray of rules in model object
TagSpecify label for SimBiology object
TypeDisplay SimBiology object type
UserDataSpecify 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

See Also

| | | | | | | | | | | |

Was this topic helpful?