Model object

Model and component information

Description

The SimBiology® model object represents a model, which is a collection of interrelated reactions and rules that transform, transport, and bind species. The model includes model components such as compartments, reactions, parameters, rules, and events. Each of the components is represented as a property of the model object. A model object also has a default configuration set object to define simulation settings. You can also add more configuration set objects to a model object.

See Property Summary for links to model property reference pages.

Properties define the characteristics of an object. Use the get and set commands to list object properties and change their values at the command line. You can graphically change object properties in the SimBiology desktop.

You can retrieve SimBiology model objects from the SimBiology root object. A SimBiology model object has its Parent property set to the SimBiology root object. The root object contains a list of model objects that are accessible from the MATLAB® command line and from the SimBiology desktop. Because both the command line and the desktop point to the same model object in the Root object, any changes you make to the model at the command line are reflected in the desktop, and vice versa.

Constructor Summary

sbiomodelConstruct model 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
Was this topic helpful?