Specify name of object
Name property identifies a SimBiology® object.
Compartments, species, parameters, and model objects can be referenced
by other objects using the
Name property, therefore
be unique for these objects. However, species names need only be unique
within each compartment. Parameter names must be unique within a model
(if at the model level), or within each kinetic law (if at the kinetic
law level). This means that you can have nonunique species names if
the species are in different compartments, and nonunique parameter
names if the parameters are in different kinetic laws or at different
levels. Note that having nonunique parameter names can cause the model
to have shadowed parameters and that may not be best modeling practice.
For more information on levels of parameters, see Scope of Parameter Objects.
Use the function
sbioselect to find an object
with the same
Name property value.
In addition, note the following constraints and reserved characters
Name property in objects:
Model and parameter names cannot be empty, the word
all whitespace, or contain the characters
Compartment and species names cannot be empty, the
null, the word
contain the characters
However, compartment and species names can contain
the name, such as
Reaction, event, and rule names cannot be the word
contain the characters
If you have a parameter, a species, or compartment
name that is not a valid MATLAB® variable name, when you write
an event function, an event trigger, a reaction, reaction rate equation,
or a rule you must enclose that name in brackets. For example, enclose
polymerase+] in brackets. In addition, if you have the same
species in multiple compartments you must qualify the species with
the compartment name, for example,
|Applies to||Objects: abstract kinetic law, configuration set, compartment, event, kinetic law, model, parameter, reaction, RepeatDose, rule, ScheduleDose, species, unit, or variant|
|Data type||Character vector|
|Data values||Any character vector except reserved words and characters|
Create a model object named
modelObj = sbiomodel ('my_model');
Add a reaction object to the model object. Note the use of brackets because the names are not valid MATLAB variable names.
reactionObj = addreaction(modelObj, '[Aspartic acid] -> [beta-Aspartyl-PO4]')
SimBiology Reaction Array Index: Reaction: 1 [Aspartic acid] -> [beta-Aspartyl-PO4]
Set the reaction
Name and verify.
set (reactionObj, 'Name', 'Aspartate kinase reaction'); get (reactionObj, 'Name')
ans = Aspartate kinase reaction