Documentation Center

  • Trial Software
  • Product Updates

UserDefinedLibrary

Library of user-defined components

Description

UserDefinedLibrary is a SimBiology® root object property containing all user-defined components of unit, unit prefixes, and kinetic laws that you define. You can add, modify, or delete components in the user-defined library. The UserDefinedLibrary property is an object that contains the following properties:

  • Units — Contains any user-defined units. You can specify units for compartment capacity, species amounts and parameter values, to do dimensional analysis and unit conversion during simulation. You can display the user-defined units either by using the command sbiowhos -userdefined -unit, or by accessing the root object.

  • UnitPrefixes — Contains any user-defined unit prefixes. You can specify unit prefixes in combination with a valid unit for compartment capacity, species amounts and parameter values, to do dimensional analysis and unit conversion during simulation. You can display the user-defined unit prefixes either by using the command sbiowhos -userdefined -unitprefix, or by accessing the root object.

  • KineticLaws — Contains any user-defined kinetic laws. Use the command sbiowhos -userdefined -kineticlaw to see the list of user-defined kinetic laws. You can use user-defined kinetic laws when you use the command addkineticlaw to create a kinetic law object for a reaction object. Refer to the kinetic law by name when you create the kinetic law object, for example, kineticlawObj = addkineticlaw(reactionObj, 'Henri-Michaelis-Menten');.

    See Kinetic Law Definition for a definition and more information.

Characteristics

Applies toObject: root
Data typeobject
Data valuesUnit, unit prefix, and abstract kinetic law objects
AccessRead-only

Characteristics for UserDefinedLibrary properties:

  • Units

    Applies toUserDefinedLibrary property
    Data typeUnit objects
    Data valuesUnits
    AccessRead/write

  • UnitPrefixes

    Applies toUserDefinedLibrary property
    Data typeUnit prefix objects
    Data valuesUnit prefixes
    AccessRead/write

  • KineticLaws

    Applies toUserDefinedLibrary property
    Data typeAbstract kinetic law object
    Data valuesKinetic laws
    AccessRead/write

Examples

Example 1

This example uses the command sbiowhos to show the current list of user-defined components.

sbiowhos -userdefined -kineticlaw
sbiowhos -userdefined -unit
sbiowhos -userdefined -unitprefix

Example 2

This example shows the current list of user-defined components by accessing the root object.

rootObj = sbioroot;
get(rootObj.UserDefinedLibrary, 'KineticLaws')
get(rootObj.UserDefinedLibrary, 'Units')
get(rootObj.UserDefinedLibrary, 'UnitPrefixes')
Was this topic helpful?