Main Content

lookup

Search for architectural element

collapse all in page

Syntax

element = lookup(object,Name=Value)
instance = lookup(object,Name=Value)

Description

element = lookup(object,Name=Value) finds an architectural element based on its universal unique identifier (UUID) or full path.

example

instance = lookup(object,Name=Value) finds an architectural element instance based on its universal unique identifier (UUID) or full path.

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.

Examples

collapse all

This example uses:

Open Live Script

This example shows how to find a component by path in a robot model.

arch = systemcomposer.loadModel("Robot");
component = lookup(arch,Path="Robot/Sensor")
component = 
  Component with properties:

     IsAdapterComponent: 0
           Architecture: [1x1 systemcomposer.arch.Architecture]
                   Name: 'Sensor'
                 Parent: [1x1 systemcomposer.arch.Architecture]
                  Ports: [1x2 systemcomposer.arch.ComponentPort]
             OwnedPorts: [1x2 systemcomposer.arch.ComponentPort]
      OwnedArchitecture: [1x1 systemcomposer.arch.Architecture]
             Parameters: [0x0 systemcomposer.arch.Parameter]
               Position: [349 74 469 174]
                  Model: [1x1 systemcomposer.arch.Model]
         SimulinkHandle: 166.0024
    SimulinkModelHandle: 152.0012
                   UUID: 'cfd62628-d365-47e4-8492-62cfeaa8dc15'
            ExternalUID: ''

Input Arguments

collapse all

Architecture model or instance object to look up, specified as a systemcomposer.arch.Model or systemcomposer.analysis.ArchitectureInstance object.

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: lookup(arch,Path="Robot/Sensor")

UUID to use for search, specified as a character vector or string of the UUID.

Example: lookup(arch,UUID="f43c9d51-9dc6-43fc-b3af-95d458b81248")

Data Types: char | string

Simulink handle to use for search, specified as the SimulinkHandle value.

Example: lookup(arch,SimulinkHandle=9.0002)

Data Types: double

Full path, specified as a character vector or string.

Example: lookup(arch,Path="Robot/Sensor")

Data Types: char | string

Output Arguments

collapse all

Model element, returned as one these objects:

Model instance, returned as a systemcomposer.analysis.ComponentInstance, systemcomposer.analysis.PortInstance, or systemcomposer.analysis.ConnectorInstance object.

More About

collapse all

Definitions

TermDefinitionApplicationMore 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.

Compose Architectures Visually

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:

  • Extract root-level architecture.

  • Apply profiles.

  • Link interface data dictionaries.

  • Generate instances from model architecture.

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:

Compose Architectures Visually

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.

  • 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. The root architecture has a boundary defined by its ports.

Compose Architectures Visually

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.

Compose Architectures Visually

TermDefinitionApplicationMore 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 MAT file, of a System Composer architecture model for analysis.

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

See Also

| | | | | |

Topics