Parameter object

Parameter and scope information

Description

The parameter object represents a parameter, which is a quantity that can change or can be constant. SimBiology^® parameters are generally used to define rate constants. You can add parameter objects to a model object or a kinetic law object. The scope of a parameter depends on where you add the parameter object: If you add the parameter object to a model object, the parameter is available to all reactions in the model and the Parent property of the parameter object is SimBiology.Model. If you add the parameter object to a kinetic law object, the parameter is available only to the reaction for which you are using the kinetic law object and the Parent property of the parameter object is SimBiology.KineticLaw.

See Property Summary for links to parameter object property reference pages.

Properties define the characteristics of an object. Use the get and set commands to list object properties and change their values at the command line. You can graphically change object properties in the graphical user interface.

Constructor Summary

addparameter (model, kineticlaw)

Create parameter object and add to model or kinetic law object

Method Summary

copyobj	Copy SimBiology object and its children
delete	Delete SimBiology object
display	Display summary of SimBiology object
findUsages	Find out how a species, parameter, or compartment is used in a model
get	Get SimBiology object properties
move	Move SimBiology species or parameter object to new parent
rename	Rename object and update expressions
set	Set SimBiology object properties

Property Summary

Constant	Specify variable or constant species amount, parameter value, or compartment capacity
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 SimBiology object type
Units	Units for species amount, parameter value, compartment capacity, observable expression
UserData	Specify data to associate with object
Value	Value of species, compartment, or parameter object
ValueUnits	Parameter value units