SimBiology.QuantityComponent

Represent SimBiology quantity objects

Description

SimBiology.QuantityComponent represents the following SimBiology quantity objects: species, compartments, and parameters.

When you have an array containing a mixture of these different objects, use the properties and functions of SimBiology.QuantityComponent to access or update all objects in the array at once.

Properties

Constant — Flag to set quantity value as constant

| true or 1 | false or 0

Flag to set the quantity value as constant, specified as a numeric or logical 1 (true) or 0 (false).

Data Types: double | logical

Name — SimBiology.QuantityComponent object name

character vector | string scalar

SimBiology.QuantityComponent object name, specified as a character vector or string scalar.

For details on requirements and recommendations for naming SimBiology^® components, see Guidelines for Naming Model Components.

Data Types: char | string

Notes — Additional information

empty character array (default) | character vector | string scalar

Additional information that you can add for the SimBiology object, specified as a character vector or string scalar.

Data Types: char | string

Parent — Parent object

Read-only: SimBiology.Model | SimBiology.Compartment | SimBiology.KineticLaw

This property is read-only.

Parent object, specified as one of the following.

• SimBiology.Model

• SimBiology.Compartment

• SimBiology.KineticLaw

Tag — Object label

empty character array (default) | character vector | string scalar

Object label, specified as a character vector or string scalar.

Data Types: char | string

Type — Object type

Read-only: 'species' | 'compartment' | 'parameter'

This property is read-only.

Object type, specified as 'species', 'compartment', or 'parameter'. When you create a SimBiology object, the value of Type is automatically defined.

Data Types: char

Units — Units for quantity value

empty character array (default) | character vector | string scalar

Units for the quantity value, specified as a character vector or string scalar.

Example: "milligram"

Data Types: char | string

UserData — Data to associate with object

[] (default) | array

Data to associate with the object, specified as any MATLAB array. For example, you can specify a scalar, vector, character vector, table, or structure. Use this property to store arbitrary data on an object.

The object does not use this data directly, but you can access it using dot notation or get.

Value — Quantity value

numeric scalar

Quantity value, specified as a numeric scalar.

Data Types: double

Object Functions

delete	Delete SimBiology object
findUsages	Find out how a species, parameter, or compartment is used in a model
get	Get SimBiology object properties
set	Set SimBiology object properties

Version History

Introduced in R2019b