Main Content

getValue

Get value of property from element instance

Description

example

[value,unit] = getValue(instance,property) obtains the property of the instance and assigns it to value.

This function is part of the systemcomposer.analysis.Instance class that you can use to analyze the model iteratively, element by element. instance refers to the element instance on which the iteration is being performed.

Examples

collapse all

Load the Small UAV model, create an architecture instance, and get the mass property value of a nested component.

scExampleSmallUAV
model = systemcomposer.loadModel('scExampleSmallUAVModel');
instance = instantiate(model.Architecture,'UAVComponent','NewInstance');
[massValue,unit] = getValue(instance.Components(1).Components(1),...
'UAVComponent.OnboardElement.Mass')
massValue =

    1.7000


unit =

    'kg'

Input Arguments

collapse all

Property, specified as a character vector in the form '<profile>.<stereotype>.<property>'.

Data Types: char

Output Arguments

collapse all

Property value, returned as a data type that depends on how the property is defined in the profile.

Property unit, returned as a character vector that describes the unit of the property as defined in the profile.

Example: 'kg'

Data Types: char

More About

collapse all

Definitions

TermDefinitionApplicationMore Information
analysisAnalysis is a method for quantitatively evaluating an architecture for certain characteristics. Static analysis analyzes the structure of the system. Static analysis uses an analysis function and parametric values of properties captured in the system model.Use analysis to calculate overall reliability, mass roll-up, performance, or thermal characteristics of a system, or to perform a SWaP analysis.Analyze Architecture
instanceAn instance is an occurrence of an architecture model at a given point of time.You can update an instance with changes to a model, but the instance will not update with changes in active variants or model references. You can use an instance, saved in an .MAT file, of a System Composer™ architecture model for analysis.Create a Model Instance for Analysis

TermDefinitionApplicationMore Information
stereotypeA stereotype is a custom extension of the modeling language. Stereotypes provide a mechanism to extend the architecture language elements by adding domain-specific metadata.Apply stereotypes to the root level architecture, component architecture, connectors, ports, and interfaces of a model. Stereotypes provide model elements within the architecture a common set of property fields, such as mass, cost, and power.Define Profiles and Stereotypes
profileA profile is a package of stereotypes to create a self-consistent domain of model element types.Apply profiles to a model through the Profile Editor. You can store stereotypes for a project in one profile or in several. Profiles are stored in .xml files when they are saved.Use Stereotypes and Profiles
propertyA property is a field in a stereotype. For each model element the stereotype is applied to, specific property values are specified.Use properties to store quantitative characteristics, such as weight or speed, that are associated with a model element. Properties can also be descriptive or represent a status.Set Properties

Introduced in R2019a