Main Content

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.

  • Event, Reaction, or Rule — When an event, a reaction, or rule object Active property is set to 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.

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

    Warning

    This property of the Configset object will be removed in a future release. Explicitly specify a configset as an input argument when you simulate a model using sbiosimulate.

  • 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.

    Warning

    This property of the Variant object will be removed in a future release. Explicitly specify a variant or an array of variants as an input argument when you simulate a model using sbiosimulate.

    .

  • Schedule dose and Repeat dose — To use a dose object in a simulation, you must add the dose object to a model object and set the Active property of the dose object to true.

    Warning

    This property of the ScheduleDose object and RepeatDose object will be removed in a future release. Explicitly specify a dose or an array of doses as an input argument when you simulate a model using sbiosimulate.

Characteristics

Applies toObjects: configset, event, observable, reaction, RepeatDose, rule, ScheduleDose, variant
Data typeboolean
Data values

true or false. The default value for events, reactions, rules, and observables is true. For the configset object, default is true. For added configset object, the default is false. For variants, the default is false.

AccessRead/write

Examples

  1. Create a model object.

    modelObj = sbiomodel ('my_model');

  2. Add a 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 the Active property to 'false' and verify.

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

    MATLAB returns:

    ans =

0