InitialAmountUnits - Species initial amount units

Description

The InitialAmountUnits property indicates the unit definition for the InitialAmount property of a species object. InitialAmountUnits can be one of the built-in units. To get a list of the defined units, use the sbioshowunits function. If InitialAmountUnits changes from one unit definition to another, InitialAmount does not automatically convert to the new units. The sbioconvertunits function does this conversion. To add a user-defined unit to the list, use sbiounit followed by sbioaddtolibrary.

See DefaultSpeciesDimension for more information on specifying dimensions for species quantities. InitialAmountUnits must have corresponding dimensions to CapacityUnits. For example, if the CapacityUnits are meter², then species must be amount/meter² or amount.

Characteristics

Applies to	Object: species
Data type	char string
Data values	Units from library with dimensions of amount, amount/length, amount/area, or amount/volume. Default is '' (empty).
Access	Read/write

Examples

1. Create a model object named my_model.

   modelObj = sbiomodel ('my_model');
   compObj = addcompartment(modelObj, 'cell');

2. Add a species object named glucose.

   speciesObj = addspecies (compObj, 'glucose');

3. Set the initial amount to 100, InitialAmountUnits to molecule, and verify.

   set (speciesObj,'InitialAmountUnits','molecule'); 
   get (speciesObj,'InitialAmountUnits')
   

   MATLAB returns:

   ans =
   
   molecule

See Also

DefaultSpeciesDimension, InitialAmount, sbioaddtolibrary, sbioconvertunits, sbioshowunits, sbiounit,

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