SimBiology.ModelComponent

R2026b

Represent SimBiology model, quantities, expressions, doses, and variants

Description

SimBiology.ModelComponent represents the following SimBiology objects: model, quantities (species, parameters, and compartments), expressions (reactions, rules, events, and observables), doses, and variants.

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

Properties

FullyQualifiedName — Unique name in the model hierarchy

Read-only: character vector

Since R2026b

This property is read-only.

Unique name in the model hierarchy, represented as a character vector. The name encodes the dot-separated path from the top-level model through each submodel to this component, for example, "PBPK.Liver.Tissue.Drug".

If a component name is not a valid MATLAB variable name, the software encloses the name in brackets, for example, "PBPK.[Lung Submodel].Tissue.Drug".

Data Types: char

Name — SimBiology.ModelComponent object name

character vector | string scalar

SimBiology.ModelComponent 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 | SimBiology.Reaction | SimBiology.Root

This property is read-only.

Parent object, specified as one of the following.

• Empty array []

• SimBiology.Model

• SimBiology.Compartment

• SimBiology.KineticLaw

• SimBiology.Reaction

• SimBiology.Root

Tag — Object label

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

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

This property will be removed in a future release. Use Tags instead.

Data Types: char | string

Tags — Object labels

empty string array (default) | character vector | string scalar | string vector | cell array of character vectors

Since R2026b

Object labels, specified as a character vector, string scalar, string vector, or cell array of character vectors. The property value is stored and returned as a string vector.

Use the property to assign multiple tags to the object, for example, to classify and group model components for selection and organization and then use sbioselect to retrieve the components.

When you load a model having components that have a nonempty Tag property value, and the Tags property is empty, the software copies the Tag value into Tags as a scalar string.

Type — Object type

Read-only: 'sbiomodel' | 'species' | 'parameter' | 'compartment' | 'reaction' | 'rule' | 'event' | 'observable' | 'repeatdose' | 'scheduledose' | 'variant'

This property is read-only.

Object type, specified as one of the following: 'sbiomodel', 'species''parameter', 'compartment', 'reaction', 'rule', 'event', 'observable', 'repeatdose', 'scheduledose', 'variant'.

When you create a SimBiology object, the value of Type is automatically defined.

Data Types: char

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.

Object Functions

delete	Delete SimBiology object
get	Get SimBiology object properties
set	Set SimBiology object properties

Version History

Introduced in R2019b

R2026b: Tags property added

Use the Tags property to assign multiple tags to the object. When you load a model having components that have a nonempty Tag property value, and the Tags property is empty, the software copies the Tag value into Tags as a scalar string.

R2026b: Tag property will be removed

The Tag property will be removed in a future release. Use the Tags property instead.