SimBiology®

Active - Indicate object in use during simulation

Description

The Active property indicates whether a simulation is using a SimBiology^® object. A SimBiology model is organized into a hierarchical group of objects. Use the Active property to include or exclude objects during a simulation.

• Configuration set – For configset object, use the method setactiveconfigset, to set the object Active property to true.

• Event, Reaction, or Rule – When an event, a reaction, or rule object Active property is set to be false, the simulation does not include the event, reaction or rule. This is a convenient way to test a model with and without a reaction or rule.

• Variant – Set the Active property to true if you always want the variant to be applied before simulating the model. You can also pass the variant object as an argument to sbiosimulate; this applies the variant only for the current simulation. For more information on using the Active property for variants see Variant object

Characteristics

Example

1. Create a model object.

   modelObj = sbiomodel ('my_model');

2. Add reaction object and verify that the Active property setting is 'true' or 1.

   reactionObj = addreaction (modelObj, 'a + b -> c + d');
   get (reactionObj, 'Active')

   MATLAB^® returns

   ans =
   
   1

3. Set Active property to 'false' and verify.

   set (reactionObj, 'Active', false);
   get (reactionObj, 'Active')

   MATLAB returns

   ans =
   
   0

See Also

Methods — addreaction, addrule, setactiveconfigset, addconfigset

Objects — Event object, Reaction object, Rule object, Variant object

AbsoluteTolerance

Annotation