SimBiology^®

sbiounitprefix - Create user-defined unit prefix

Syntax

unitprefixObject = sbiounitprefix('NameValue') unitprefixObject = sbiounitprefix('NameValue', 'ExponentValue') unitprefixObject = sbiounitprefix('NameValue', ...'PropertyName', PropertyValue ...)

Arguments

`NameValue`	`NameValue` is the name of the user-defined unit prefix. `NameValue` must begin with characters and can contain characters, underscores or numbers. `NameValue` can be any valid MATLAB^® variable name.
`ExponentValue`	`ExponentValue` shows the value of `10^Exponent` that defines the relationship of the unit `Name` to the base unit. For example, for the unit `picomole`, `Exponent` is `–12`.
`PropertyName`	Name of the unit prefix object property. For example '`Notes`'
`PropertyValue`	Value of the unit prefix object property. For example '`New unitprefix for GPCR model`'

Description

unitprefixObject = sbiounitprefix('NameValue') constructs a SimBiology^® unit prefix object with name, NameValue. Valid names must begin with a letter, and be followed by letters, underscores, or numbers.

unitprefixObject = sbiounitprefix('NameValue', 'ExponentValue') creates a unit prefix object with a multiplicative factor of 10^'ExponentValue'.

unitprefixObject = sbiounitprefix('NameValue', ...'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).

In order to use unitprefixObject, you must add it to the user-defined library with the sbioaddtolibrary function. To get the unit prefix object into the user-defined library, use the following command:

sbioaddtolibrary(unitprefixObject);

You can view additional unitprefixObject properties with the get command. You can modify additional properties with the set command.

Use the sbioshowunitprefixes function to list the units available in the user-defined library.

Examples

This example shows you how to create a user-defined unitprefix, add it to the user-defined library, and query the library.

Create a unitprefix.

unitprefixObj1 = sbiounitprefix('peta', 15);

Add the unitprefix to the user-defined library.
```
sbioaddtolibrary(unitprefixObj1);
```

Query the user-defined library in the root object.

rootObj = sbioroot;

rootObj.UserDefinedLibrary.UnitPrefixes

Unit Prefix Array

   Index:  Library:     Name:             Exponent:

   1       UserDefined  peta               15

Alternatively, use the sbiowhos command.

sbiowhos -userdefined -unitprefix

SimBiology UserDefined Unit Prefixes
           
   Index:  Name:           Multiplier:              
   1       peta            1.000000e+015

sbiounitprefix - Create user-defined unit prefix

Syntax

Arguments

Description

Examples

See Also