Main Content

getValue

Get value of property from element instance

Description

example

[value,unit] = getValue(instance,property) obtains the property property of the instance instance and assigns it to the specified value 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 or string in the form '<profile>.<stereotype>.<property>'.

Data Types: char | string

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 analyses to calculate overall reliability, mass roll-up, performance, or thermal characteristics of a system, or to perform a SWaP analysis.
analysis functionAn analysis function is a MATLAB® function that computes values necessary to evaluate the architecture using properties of each element in the model instance.Use an analysis function to calculate the result of an analysis.Write Analysis Function
instance modelAn instance model is a collection of instances.You can update an instance model with changes to a model, but the instance model will not update with changes in active variants or model references. You can use an instance model, saved in an .MAT file, of a System Composer™ architecture model for analysis.Run Analysis Function
instanceAn instance is an occurrence of an architecture model element at a given point in time.An instance freezes the active variant or model reference of the component in the instance model.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 elements: root-level architecture, component architecture, connectors, ports, data interfaces, and value types of a model. A model element can have multiple stereotypes. Stereotypes provide model elements with a common set of property fields, such as mass, cost, and power.Extend Architectural Design Using Stereotypes
propertyA property is a field in a stereotype. For each 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. You can view and edit the properties of each element in the architecture model using the Property Inspector.
profileA profile is a package of stereotypes to create a self-consistent domain of element types.Author profiles and apply profiles to a model using 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.

Introduced in R2019a