ValueUnits - Parameter value units

Description

The ValueUnits property indicates the unit definition of the parameter object Value property. ValueUnits can be one of the built-in units. To get a list of the built-in units, use the sbioshowunits function. If ValueUnits changes from one unit definition to another, the Value does not automatically convert to the new units. The sbioconvertunits function does this conversion.

You can add a parameter object to a model object or a kinetic law object.

Characteristics

Applies to	Object: parameter
Data type	char string
Data values	Unit from units library. Default is '' (empty string). Note that the default value of an empty string means unspecified. Unspecified units are permitted during dimensional analysis, but not during unit conversion. (Use the string 'dimensionless' to specify dimensionless units.)
Access	Read/write

Examples

Assign a parameter with a value to the model object.

1. Create a model object, and then add a reaction object.

   modelObj = sbiomodel('my_model');
   

2. Add a parameter with Value 0.5, and assign it to the model object (modelObj).

   parameterObj1 = addparameter(modelObj, 'K1', 0.5, 'ValueUnits', '1/second')
   

   MATLAB returns:

   SimBiology Parameter Array
   
   Index:    Name:    Value:    ValueUnits:
    1         K1       0.5       1/second

See Also

addparameter, sbioconvertunits, sbioshowunits

© 1984-2012- The MathWorks, Inc.    -   Site Help   -   Patents   -   Trademarks   -   Privacy Policy   -   Preventing Piracy   -   RSS