addvariant (model)

Add variant to model

Syntax

variantObj = addvariant(modelObj, 'NameValue')
variantObj2 = addvariant(modelObj, variantObj)


Arguments

modelObj	Specify the Model object to which you want add a variant.
variantObj	Variant object to create and add to the model object.
NameValue	Name of the variant object. NameValue is assigned to the Name property of the variant object.

Description

variantObj = addvariant(modelObj, 'NameValue') creates a SimBiology^® variant object (variantObj) with the name NameValue and adds the variant object to the SimBiology Model object modelObj. The variant object Parent property is assigned the value of modelObj.

A SimBiology variant object stores alternate values for properties on a SimBiology model. For more information on variants, see Variant object.

variantObj2 = addvariant(modelObj, variantObj) adds a SimBiology variant object (variantObj) to the SimBiology model object and returns another variant object variantObj2. The variant object variantObj2 Parent property is assigned the value of modelObj. The Active property of variantObj2 is set to false by default.

View properties for a variant object with the get command, and modify properties for a variant object with the set command.

Note

• Remember to use the addcontent method instead of using the set method on the Content property, because the set method replaces the data in the Content property, whereas addcontent appends the data.

• When there are multiple active variant objects on a model, if there are duplicate specifications for a property's value, the last occurrence for the property value in the array of variants, is used during simulation.

To view the variants stored on a model object, use the getvariant method. To copy a variant object to another model, use copyobj. To remove a variant object from a SimBiology model, use the delete method.

Examples

1. Create a model containing one species.

   modelObj = sbiomodel('mymodel');
   compObj = addcompartment(modelObj, 'comp1');
   speciesObj = addspecies(compObj, 'A');

2. Add a variant object that varies the InitialAmount property of a species named A.

   variantObj = addvariant(modelObj, 'v1');
   addcontent(variantObj, {'species', 'A', 'InitialAmount', 5});

Version History

Introduced in R2007b

R2024a: Having duplicate model component names is no longer allowed

• When you load a model that contains duplicate names, SimBiology automatically updates those names. SimBiology disambiguates the duplicate names by adding a suffix "_N", where N is the first positive integer that results in a unique name. If there is an existing suffix, N will be incremented from that suffix. For example, if there are two model components named x_3, the function updates one of the names to x_4. If the existing suffix has leading zeros, the function omits the zeros in the new name. For instance, if x_003 is a duplicate name, it gets renamed to x_4. However, the function assumes that names with leading zeros and without leading zeros are different. For instance, x_005 and x_5 are considered to be different names.

• SimBiology issues an error if multiple model components (model, compartment, species, parameter, reaction, rule, event, observable, dose, and variant) have the same name. Within a single model, these components are required to have unique names even when they are of different types with the following two exceptions:

  • Species in different compartments can have the same name.

  • Parameters can have the same name if they are scoped to different parents. Specifically, you can use the same name for a model-scoped parameter and reaction-scoped parameters, where each reaction-scoped parameter belongs to a different reaction.

  For details on how to reference model component names in expressions, see Guidelines for Referencing Names in Expressions.

R2022b: Having duplicate model component names issues a warning

SimBiology issues a warning if multiple model components have the same name.

R2022a: Having duplicate model component names will not be allowed in a future release

SimBiology will not allow you to have duplicate names for model components within a model.