Main Content

delete

Delete SimBiology object

collapse all in page

Syntax

delete(sobj)

Description

delete(sobj) deletes the SimBiology object sobj and removes it from its parent object.

Note

You can also use sbioreset to delete all model objects from the SimBiology root object, which contains a list of model objects, available units, unit prefixes, and kinetic laws.

example

Examples

collapse all

Open Live Script

Load the G-protein model.

sbioloadproject('gprotein.sbproj');

Get the model-scoped parameters.

params = m1.Parameters
params = 
   SimBiology Parameter Array

   Index:    Name:     Value:      Units:
   1         kRLm      0.01              
   2         kRL       3.32e-18          
   3         kRdo      0.0004            
   4         kRs       4                 
   5         kRD1      0.004             
   6         kG1       1                 
   7         kGa       1e-05             
   8         kGd       0.11              
   9         GaFrac    1

Delete the parameters.

delete(params)
m1.Parameters
ans = 
  0x1 Parameter array with properties:

    ValueUnits
    ConstantValue
    Constant
    Value
    Units
    BoundaryCondition
    Name
    Parent
    Notes
    Tag
    Type
    UserData

Input Arguments

collapse all

Object, specified as a SimBiology object or array of SimBiology objects.

  • If sobj is a model object, the model is deleted from the root object. delete removes all references to the model at the command line and in the SimBiology and SimBiology Model Analyzer apps.

  • If sobj is a species object used by a reaction object, the function issues a warning, and the species object is not deleted. You need to delete the reaction or remove the species from the reaction before you can delete the species object.

  • If sobj is a parameter object used by a kinetic law object, there is no warning when the object is deleted. However, when you try to simulate your model, an error occurs because the parameter cannot be found.

  • If sobj is a reaction object, the function deletes the object, but the species objects that were being used by the reaction object are not deleted.

  • If sobj is an abstract kinetic law object and there is a kinetic law object referencing it, the function returns an error.

  • If sobj is a configuration set object, and it is the active configuration set object, the function, after deleting the object, makes the default configuration set object active. Note that you cannot delete the default configuration set.

  • You cannot delete the SimBiology root object or a SimData object.

Version History

Introduced in R2006a

See Also