iterate
Iterate over model elements
Syntax
Description
iterate(
iterates over components in the architecture arch
,iterType
,iterFunction
)arch
in the order
specified by iterType
and invokes the function specified by the
function handle iterFunction
on each component.
Note
This function is part of the instance programmatic interfaces that you can use to analyze
the model iteratively, element-by-element. The instance
refers to the
element instance on which the iteration is being performed.
iterate(___,
iterates
over components in the architecture using all previous syntaxes with additional
options.Name=Value
)
iterate(___,
iterates over components in the architecture with additional options and passes all trailing
arguments, specified as Name=Value
,additionalArgs
)additionalArgs
, as arguments to
iterFunction
. Name-value arguments with
additionalArgs
must be specified as comma-separated name-value
pairs.
Examples
Compute Battery Capacity
For more information on the battery sizing example, see Battery Sizing and Automotive Electrical System Analysis.
openExample("systemcomposer/BatterySizingAndAutomotiveAnalysisExample") archModel = systemcomposer.openModel("scExampleAutomotiveElectricalSystemAnalysis"); % Instantiate battery sizing class used by analysis function to store % analysis results. objcomputeBatterySizing = computeBatterySizing; % Run the analysis using the iterator iterate(archModel,"TopDown",@computeLoad,"Recurse",true,objcomputeBatterySizing);
Input Arguments
arch
— Architecture over which to iterate
architecture object | architecture instance object
Architecture over which to iterate, specified as an systemcomposer.arch.Architecture
or systemcomposer.analysis.ArchitectureInstance
object.
iterType
— Iteration type
"PreOrder"
| "PostOrder"
| "TopDown"
| "BottomUp"
Iteration type, specified as "PreOrder"
,
"PostOrder"
, "TopDown"
, or
"BottomUp"
.
Pre-order
— Start from the top level, move to a child component, and process the subcomponents of that component recursively before moving to a sibling component.Top-Down
— Like pre-order, but process all sibling components before moving to their subcomponents.Post-order
— Start from components with no subcomponents, process each sibling, and then move to parent.Bottom-up
— Like post-order, but process all subcomponents at the same depth before moving to their parents.
Data Types: char
| string
iterFunction
— Iteration function
function handle
Iteration function, specified as a function handle to be iterated on each component.
additionalArgs
— Additional function arguments
comma-separated list of function arguments
Additional function arguments, specified as a comma-separated list of arguments to
be passed to iterFunction
.
Name-Value Arguments
Specify optional pairs of arguments as
Name1=Value1,...,NameN=ValueN
, where Name
is
the argument name and Value
is the corresponding value.
Name-value arguments must appear after other arguments, but the order of the
pairs does not matter.
Before R2021a, use commas to separate each name and value, and enclose
Name
in quotes.
Example: iterate(archModel,"TopDown",@computeLoad,"Recurse",true,objcomputeBatterySizing)
Recurse
— Option to recursively iterate through model components
1
(true
) (default) | 0
(false
)
Option to recursively iterate through model components, specified as
1
(true
) to recursively iterate or
0
(false
). to iterate over components only in
this architecture and not navigate into the architectures of child components.
Recurse
only applies to systemcomposer.arch.Architecture
objects.
Data Types: logical
IncludePorts
— Option to iterate over components and architecture ports
0
(false
) (default) | 1
(true
)
Option to iterate over components and architecture ports, specified as
0
(false
). to only iterate over components or
1
(true
) to iterate over components and
architecture ports.
Data Types: logical
IncludeConnectors
— Option to iterate over components and connectors
0
(false
) (default) | 1
(true
)
Option to iterate over components and connectors, specified as
0
(false
). to only iterate over components or
1
(true
) to iterate over components and
connectors.
IncludeConnectors
only applies to systemcomposer.analysis.ArchitectureInstance
objects.
Data Types: logical
FollowConnectivity
— Option to ensure iteration order
0
(false
) (default) | 1
(true
)
Option to ensure iteration order according to how components are connected from
source to destination, specified as 0
(false
). or
1
(true
). If this option is specified as
1
(true
), iteration type
iterType
has to be either "TopDown"
or
"BottomUp"
. If any other option is specified, the iteration type
defaults to "TopDown"
.
FollowConnectivity
only applies to systemcomposer.arch.Architecture
objects.
Data Types: logical
More About
Definitions
Term | Definition | Application | More Information |
---|---|---|---|
architecture | A System Composer™ architecture represents a system of components and how they interface with each other structurally and behaviorally. |
Different types of architectures describe different aspects of systems. You can use views to visualize a subset of components in an architecture. You can define parameters on the architecture level using the Parameter Editor. | |
root | A root is at the top of an architecture hierarchy. A root architecture has a boundary defined by its architecture ports that surround the system of interest. | The root architecture has a system boundary surrounding your architecture model. You can add architecture ports that define interfaces across the boundary. | |
model | A System Composer model is the file that contains architectural information, such as components, ports, connectors, interfaces, and behaviors. |
Perform operations on a model:
A System Composer model is stored as an SLX file. | Create Architecture Model with Interfaces and Requirement Links |
component | A component is a replaceable part of a system that fulfills a clear function in the context of an architecture. A component defines an architectural element, such as a function, another system, hardware, software, or other conceptual entity. A component can also be a subsystem or subfunction. | Represented as a block, a component is a part of an architecture model that can be separated into reusable artifacts. Transfer information between components with:
| |
port | A port is a node on a component or architecture that represents a point of interaction with its environment. A port permits the flow of information to and from other components or systems. |
| |
connector | Connectors are lines that provide connections between ports. Connectors describe how information flows between components or architectures. | A connector allows two components to interact without defining the nature of the interaction. Set an interface on a port to define how the components interact. |
Term | Definition | Application | More Information |
---|---|---|---|
analysis | Analysis 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 and parameters 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 size, weight, and power (SWaP) analysis to increase efficiency. | |
analysis function | An analysis function is a MATLAB® function that computes values necessary to evaluate the architecture using the properties of each element in the model instance and instance-specific parameters on the component and architecture level. | Use an analysis function to calculate the result of an analysis. | |
instance model | An 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 a | Run Analysis Function |
instance | An 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 |
Version History
Introduced in R2019a
MATLAB Command
You clicked a link that corresponds to this MATLAB command:
Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)