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});