Property Reference

Alphabetical List

---

Abstract Kinetic Law Properties for abstract kinetic law objects Compartments Properties for compartment objects Configuration Sets Properties for configuration set objects CovariateModel Properties for CovariateModel objects Events Properties for event objects Kinetic Laws Properties for kinetic law objects Models Properties for model objects NMFileDef Properties for NMFileDef objects Parameters Properties for parameter objects PKCompartment Properties for PKCompartment objects PKData Properties for PKData objects PKCovariateModel Properties for PKCovariateModel objects PKModelDesign Properties for PKModelDesign objects PKModelMap Properties for PKModelMap objects Reactions Properties for reaction objects RepeatDose Properties for RepeatDose objects Root Properties for the root object Rules Properties for rule objects ScheduleDose Properties for ScheduleDose objects SimData Properties for SimData objects Species Properties for species objects Unit Properties for unit objects Unit Prefix Properties for unit objects Variant Properties for variant objects Using Object Properties Command-line syntax for entering and retrieving property values

Back to Top

Abstract Kinetic Law

Annotation	Store link to URL or file
Expression (AbstractKineticLaw, KineticLaw)	Expression to determine reaction rate equation
Name	Specify name of object
Notes	HTML text describing SimBiology object
ParameterVariables	Parameters in kinetic law definition
Parent	Indicate parent object
SpeciesVariables	Species in abstract kinetic law
Tag	Specify label for SimBiology object
Type	Display SimBiology object type
UserData	Specify data to associate with object

Back to Top

Compartments

Annotation	Store link to URL or file
Capacity	Compartment capacity
CapacityUnits	Compartment capacity units
Compartments	Array of compartments in model or compartment
ConstantCapacity	Specify variable or constant compartment capacity
Name	Specify name of object
Notes	HTML text describing SimBiology object
Owner	Owning compartment
Parent	Indicate parent object
Species	Array of species in compartment object
Tag	Specify label for SimBiology object
Type	Display SimBiology object type
UserData	Specify data to associate with object

Back to Top

Configuration Sets

Active	Indicate object in use during simulation
CompileOptions	Dimensional analysis and unit conversion options
Name	Specify name of object
Notes	HTML text describing SimBiology object
RuntimeOptions	Options for logged species
SensitivityAnalysisOptions	Specify sensitivity analysis options
SolverOptions	Specify model solver options
SolverType	Select solver type for simulation
StartTime	Start time for simulation or initial dose time
StopTime	Stop time for simulation
StopTimeType	Specify type of stop time for simulation
TimeUnits	Show time units for dosing and simulation
Type	Display SimBiology object type

Back to Top

CovariateModel

CovariateLabels (CovariateModel)	Labels for covariates in CovariateModel object
Expression (CovariateModel)	Define relationship between parameters and covariates
FixedEffectDescription (CovariateModel)	Descriptions of fixed effects in CovariateModel object
FixedEffectNames (CovariateModel)	Names of fixed effects in CovariateModel object
FixedEffectValues (CovariateModel)	Values for initial estimates of fixed effects in CovariateModel object
ParameterNames (CovariateModel)	Names of parameters in CovariateModel object
RandomEffectNames (CovariateModel)	Names of random effects in CovariateModel object

Back to Top

Events

Properties for event objects

Active	Indicate object in use during simulation
Annotation	Store link to URL or file
EventFcns	Event expression
Name	Specify name of object
Notes	HTML text describing SimBiology object
Parent	Indicate parent object
Tag	Specify label for SimBiology object
Trigger	Event trigger
Type	Display SimBiology object type
UserData	Specify data to associate with object

Back to Top

Kinetic Laws

Annotation	Store link to URL or file
Expression (AbstractKineticLaw, KineticLaw)	Expression to determine reaction rate equation
KineticLawName	Name of kinetic law applied to reaction
Name	Specify name of object
Notes	HTML text describing SimBiology object
Parameters	Array of parameter objects
ParameterVariableNames	Cell array of reaction rate parameters
ParameterVariables	Parameters in kinetic law definition
Parent	Indicate parent object
SpeciesVariableNames	Cell array of species in reaction rate equation
SpeciesVariables	Species in abstract kinetic law
Tag	Specify label for SimBiology object
Type	Display SimBiology object type
UserData	Specify data to associate with object

Back to Top

Models

Annotation	Store link to URL or file
Compartments	Array of compartments in model or compartment
Events	Contain all event objects
Models	Contain all model objects
Name	Specify name of object
Notes	HTML text describing SimBiology object
Parameters	Array of parameter objects
Parent	Indicate parent object
Reactions	Array of reaction objects
Rules	Array of rules in model object
Tag	Specify label for SimBiology object
Type	Display SimBiology object type
UserData	Specify data to associate with object

Back to Top

NMFileDef

Back to Top

Parameters

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 SimBiology object type
UserData	Specify data to associate with object
Value	Assign value to parameter object
ValueUnits	Parameter value units

Back to Top

PKCompartment

DosingType	Drug dosing type in compartment
EliminationType	Drug elimination type from compartment
HasLag	Lag associated with dose targeting compartment
HasResponseVariable	Compartment drug concentration reported
Name	Specify name of object

Back to Top

PKData

CovariateLabels	Identify covariate columns in data set
DataSet	Dataset object containing imported data
DependentVarLabel	Identify dependent variable column in data set
DependentVarUnits	Response units in PKData object
DoseLabel	Dose column in data set
DoseUnits	Dose units in PKData object
GroupID	Integer identifying each group in data set
GroupLabel	Identify group column in data set
GroupNames	Unique values from GroupLabel in data set
IndependentVarLabel	Identify independent variable column in data set
IndependentVarUnits	Time units in PKData object
RateLabel	Rate of infusion column in data set
RateUnits	Units for dose rate

Back to Top

PKCovariateModel

Expression (PKCovariateModel)

Define the relationship between parameters and covariates

Back to Top

PKModelDesign

PKCompartments

Hold compartments in PK model

Back to Top

PKModelMap

Dosed	Dosed object name
DosingType	Drug dosing type in compartment
Estimated	Names of parameters to estimate
LagParameter	Parameter specifying time lag for doses
Observed	Measured response object name
ZeroOrderDurationParameter	Zero-order dose absorption duration

Back to Top

Reactions

Active	Indicate object in use during simulation
Annotation	Store link to URL or file
KineticLaw	Show kinetic law used for ReactionRate
Name	Specify name of object
Notes	HTML text describing SimBiology object
Parent	Indicate parent object
Products	Array of reaction products
Reactants	Array of reaction reactants
Reaction	Reaction object reaction
ReactionRate	Reaction rate equation in reaction object
Reversible	Specify whether reaction is reversible or irreversible
Stoichiometry	Species coefficients in reaction
Tag	Specify label for SimBiology object
Type	Display SimBiology object type
UserData	Specify data to associate with object

Back to Top

RepeatDose

Active	Indicate object in use during simulation
Amount	Amount of dose
AmountUnits	Dose amount units
Annotation	Store link to URL or file
DurationParameterName	Parameter specifying length of time
Interval	Time between doses
LagParameterName	Parameter specifying time lag for dose
Name	Specify name of object
Notes	HTML text describing SimBiology object
Parent	Indicate parent object
Rate	Rate of dose
RateUnits	Units for dose rate
RepeatCount	Dose repetitions
StartTime	Start time for simulation or initial dose time
Tag	Specify label for SimBiology object
TargetName	Species receiving dose
TimeUnits	Show time units for dosing and simulation
Type	Display SimBiology object type
UserData	Specify data to associate with object

Back to Top

Root

BuiltInLibrary	Library of built-in components
Models	Contain all model objects
Type	Display SimBiology object type
UserDefinedLibrary	Library of user-defined components

Back to Top

Rules

Active	Indicate object in use during simulation
Annotation	Store link to URL or file
Name	Specify name of object
Notes	HTML text describing SimBiology object
Parent	Indicate parent object
Rule	Specify species and parameter interactions
RuleType	Specify type of rule for rule object
Tag	Specify label for SimBiology object
Type	Display SimBiology object type
UserData	Specify data to associate with object

Back to Top

ScheduleDose

Active	Indicate object in use during simulation
Amount	Amount of dose
AmountUnits	Dose amount units
Annotation	Store link to URL or file
DurationParameterName	Parameter specifying length of time
LagParameterName	Parameter specifying time lag for dose
Name	Specify name of object
Notes	HTML text describing SimBiology object
Parent	Indicate parent object
Rate	Rate of dose
RateUnits	Units for dose rate
Tag	Specify label for SimBiology object
TargetName	Species receiving dose
Time	Simulation time steps or schedule dose times
TimeUnits	Show time units for dosing and simulation
Type	Display SimBiology object type
UserData	Specify data to associate with object

Back to Top

SimData

Data	Store simulation data
DataCount	Numbers of species, parameters, sensitivities
DataInfo	Metadata labels for simulation data
DataNames	Show names in SimData object
ModelName	Name of model simulated
Name	Specify name of object
Notes	HTML text describing SimBiology object
RunInfo	Information about simulation
Time	Simulation time steps or schedule dose times
TimeUnits	Show time units for dosing and simulation
UserData	Specify data to associate with object

Back to Top

Species

Annotation	Store link to URL or file
BoundaryCondition	Indicate species boundary condition
ConstantAmount	Specify variable or constant species amount
InitialAmount	Species initial amount
InitialAmountUnits	Species initial amount units
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
UserData	Specify data to associate with object

Back to Top

Unit

Annotation	Store link to URL or file
Composition	Unit composition
Multiplier	Relationship between defined unit and base unit
Name	Specify name of object
Notes	HTML text describing SimBiology object
Offset	Unit composition modifier
Parent	Indicate parent object
Tag	Specify label for SimBiology object
Type	Display SimBiology object type
UserData	Specify data to associate with object

Back to Top

Unit Prefix

Annotation	Store link to URL or file
Exponent	Exponent value of unit prefix
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
UserData	Specify data to associate with object

Back to Top

Variant

Active	Indicate object in use during simulation
Annotation	Store link to URL or file
Content	Contents of variant object
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
UserData	Specify data to associate with object

Back to Top

Using Object Properties

Command-line syntax for entering and retrieving property values.

Entering Property Values Use either MATLAB functions or object dot notation to enter or change property values. Retrieving Property Values Use either MATLAB functions or object dot notation to get property values. Help for Objects, Methods, and Properties Use the command sbiohelp to get information about properties.

Back to Top of Section

Entering Property Values

Enter or change a single property value using dot notation.

ObjectName.PropertyName = PropertyValue

Enter or change one or more property values using the MATLAB function set.

set(ObjectName, 'Propertyname', PropertyValue, ...)

Back to Top of Section

Retrieving Property Values

Retrieve a single property value using dot notation.

PropertyValue = ObjectName.PropertyName

Retrieve one or more property values using the MATLAB function get.

PropertyValue(s) = get(ObjectName, 'PropertyName', ...)

Retrieve one or more property values using the object method get.

PropertyValue(s) = ObjectName.get('PropertyName', ...)

List or retrieve all property values using one of the following commands:

get(ObjectName)
AllPropertyValues = get(ObjectName)

ObjectName.get

Back to Top of Section

Help for Objects, Methods, and Properties

Display information for SimBiology object methods and properties in the MATLAB Command Window.

help sbio	Display a list of functions and methods.
help FunctionName	Display function information.
sbiohelp('MethodName')	Display method information.
sbiohelp('PropertyName')	Display property information.

Methods — Alphabetical List

Properties — Alphabetical List

© 1984-2012- The MathWorks, Inc.    -   Site Help   -   Patents   -   Trademarks   -   Privacy Policy   -   Preventing Piracy   -   RSS