Learn more about SimBiology

sbioparameter - Construct parameter object

Note sbioparameter has been removed and produces an error. Use addparameter instead.

Syntax

parameterObj = sbioparameter(Obj, NameValue) parameterObj = sbioparameter(Obj, NameValue, ValueValue) parameterObj = sbioparameter(...'PropertyName', PropertyValue...)

Arguments

Obj Model object or kinetic law object.

NameValue

Property for a parameter object. Enter a unique character string.

Since objects can use this property to reference a parameter, a parameter object must have a unique name at the level it is created. For example, a kinetic law object cannot contain two parameter objects named kappa. However, the model object that contains the kinetic law object can contain a parameter object named kappa along with the kinetic law object.

You can use the function sbioselect to find an object with a specific Name property value.

For information on naming parameters, see Name.

ValueValue Value of a parameter object. Enter a number.

Description

parameterObj = sbioparameter(Obj, NameValue) constructs a SimBiology parameter object, enters a value (NameValue) for the required property Name, and returns the object (parameterObj).

To use a parameter object (paramaterObj) in a simulation, you must add the object to a SimBiology model, or kinetic law object with the method copyobj. You can use the addparameter method to simultaneously create and assign a parameter to a model or kinetic law object.

parameterObj = sbioparameter(Obj, NameValue, ValueValue) creates a parameter object, assigns a value (NameValue) to the property Name, assigns the value (ValueValue) to the property Value and returns the parameter object to a variable (parameterObj).

parameterObj = sbioparameter(...'PropertyName', PropertyValue...) defines optional properties. The property name/property value pairs can be in any format supported by the function set (for example, name-value string pairs, structures, and name-value cell array pairs).

Copy a SimBiology parameter object to a SimBiology model or kinetic law object with the method copyobj. Remove a parameter object from a model or kinetic law object with the method delete.

View additional parameter object properties with the get command. Modify additional parameter object properties with the set command. You can find help for parameterObj properties with the help PropertyName command and help for functions with the sbiohelp FunctionName command.

Method Summary

copyobj (any object)	Copy SimBiology object and its children
delete (any object)	Delete SimBiology object
display (any object)	Display summary of SimBiology object
get (any object)	Get object properties
rename (compartment, parameter, species)	Rename object and update expressions
set (any object)	Set object properties

Property Summary

Annotation	Store link to URL or file
ConstantValue	Specify variable or constant parameter value
Name	Specify name of object
Notes	HTML text describing SimBiology object
Parent	Indicate parent object
Tag	Specify label for SimBiology object
Type	Display top-level SimBiology object type
UserData	Specify data to associate with object
Value	Assign value to parameter object
ValueUnits	Parameter value units

Examples

Construct a parameter object.

parameterObj = sbioparameter('kappa', 1);
% View the help for the parameter object's Value property.
help(parameterObj, 'Value')

View parameter object properties.

get(parameterObj)

MATLAB returns:

        Annotation: ''
    ConstantValue: 1
             Name: 'kappa'
            Notes: ''
           Parent: [1x1 SimBiology.Reaction]
              Tag: ''
             Type: 'parameter'
         UserData: []
            Value: 4
       ValueUnits: '