iterate

Iterate over model elements

Syntax

iterate(architecture,iterType,iterFunction)

iterate(___,Name,Value)

iterate(___,additionalArgs)

Description

iterate(architecture,iterType,iterFunction) iterates over components in the architecture in the order specified by iterType and invokes the function specified by the function handle iterFunction on each component.

iterate(___,Name,Value) iterates over components in the architecture, with additional options specified by one or more name-value pair arguments.

iterate(___,additionalArgs) passes all trailing arguments as arguments to iterFunction.

Examples

Battery Capacity Computation

Open the example Battery Sizing and Automotive Electrical System Analysis.

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,objcomputeBatterySizing);

Input Arguments

architecture — Architecture to iterate over

architecture object | architecture instance object

Architecture to iterate over, 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'.

Data Types: char

iterFunction — Iteration function

function handle

Iteration function, specified as a function handle to be iterated on each component.

Data Types: string

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 Pair Arguments

Specify optional comma-separated pairs of Name,Value arguments. Name is the argument name and Value is the corresponding value. Name must appear inside quotes. You can specify several name and value pair arguments in any order as Name1,Value1,...,NameN,ValueN.

Example: iterate(archModel,'Topdown',@computeLoad,objcomputeBatterySizing)

'Recurse' — Option to recursively iterate through model components

true or 1 (default) | false or 0

Option to recursively iterate through model components, specified as the comma-separated pair consisting of 'Recurse' and a logical 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' does not apply to a systemcomposer.analysis.ArchitectureInstance object. The architecture model is flattened.

Data Types: logical

'IncludePorts' — Option to iterate over components and architecture ports

false or 0 (default) | true or 1

Option to iterate over components and architecture ports, specified as the comma-separated pair consisting of 'IncludePorts' and a logical 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

false or 0 (default) | true or 1

Option to iterate over components and connectors, specified as the comma-separated pair consisting of 'IncludeConnectors' and a logical 0 (false) to only iterate over components or 1 (true) to iterate over components and connectors.

Data Types: logical

'FollowConnectivity' — Option to ensure iteration order

false or 0 (default) | true or 1

Option to ensure iteration order according to how components are connected from source to destination, specified as the comma-separated pair consisting of 'FollowConnectivity' and a logical 0 (false) or 1 (true). If this option is specified as 1 (true), iteration type has to be either 'TopDown' or 'BottomUp'. If any other option is specified, iteration defaults to 'TopDown'.

'FollowConnectivity' does not apply to a systemcomposer.analysis.ArchitectureInstance object.

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. You can represent specific architectures using alternate views.	Different types of architectures describe different aspects of systems: Functional architecture describes the flow of data in a system. Logical architecture describes the intended operation of a system. Physical architecture describes the platform or hardware in a system.	Compose Architecture Visually
model	A System Composer model is the file that contains architectural information, including components, ports, connectors, interfaces, and behaviors.	Perform operations on a model: Extract the root level architecture contained in the model. Apply profiles. Link interface data dictionaries. Generate instances from model architecture. System Composer models are stored as .slx files.	Create an Architecture Model
component	A component is a nontrivial, nearly-independent, and replaceable part of a system that fulfills a clear function in the context of an architecture. A component defines an architecture element, such as a function, a 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.	Components
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.	There are different types of ports: Component ports are interaction points on the component to other components. Architecture ports are ports on the boundary of the system, whether the boundary is within a component or the overall architecture model.	Ports
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.	Connections

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 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
instance	An 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