getAllocatedTo

Get allocation target

Syntax

targetElements = getAllocatedTo(allocScenario,sourceElement)

Description

targetElements = getAllocatedTo(allocScenario,sourceElement) gets all allocated target elements to which the specified source element sourceElement is allocated.

Examples

Allocate to Target Component

Create two new models with one component each.

mSource = systemcomposer.createModel("Source_Model_Allocation");
systemcomposer.openModel("Source_Model_Allocation");
sourceComp = addComponent(get(mSource,"Architecture"),"Source_Component");
mTarget = systemcomposer.createModel("Target_Model_Allocation");
systemcomposer.openModel("Target_Model_Allocation");
targetComp = addComponent(get(mTarget,"Architecture"),"Target_Component");

Create an allocation set named MyNewAllocation.

allocSet = systemcomposer.allocation.createAllocationSet("MyNewAllocation",...
     "Source_Model_Allocation","Target_Model_Allocation");

Get the default allocation scenario.

defaultScenario = getScenario(allocSet,"Scenario 1");

Allocate components between models.

allocation = allocate(defaultScenario,sourceComp,targetComp);

Get allocated to target component allocated from source component.

targetElement = getAllocatedTo(defaultScenario,sourceComp)

targetElement = 

  Component with properties:

     IsAdapterComponent: 0
           Architecture: [1×1 systemcomposer.arch.Architecture]
                   Name: 'Target_Component'
                 Parent: [1×1 systemcomposer.arch.Architecture]
                  Ports: [0×0 systemcomposer.arch.ComponentPort]
             OwnedPorts: [0×0 systemcomposer.arch.ComponentPort]
      OwnedArchitecture: [1×1 systemcomposer.arch.Architecture]
               Position: [15 15 65 76]
                  Model: [1×1 systemcomposer.arch.Model]
         SimulinkHandle: 5.0001
    SimulinkModelHandle: 3.0001
                   UUID: '15b4e0ba-f236-4f59-9d30-b46cf170cbda'
            ExternalUID: ''

Input Arguments

allocScenario — Allocation scenario

allocation scenario object

Allocation scenario , specified as a systemcomposer.allocation.AllocationScenario object.

sourceElement — Source element

element object

Source element, specified as a systemcomposer.arch.Element object.

An element object translates to a systemcomposer.arch.Component, systemcomposer.arch.VariantComponent, systemcomposer.arch.ComponentPort, systemcomposer.arch.ArchitecturePort, systemcomposer.arch.Connector, or systemcomposer.arch.PhysicalConnector object.

Output Arguments

targetElements — Target elements

array of element objects

Target elements to which source element is allocated, specified as an array of systemcomposer.arch.Element objects.

An element object translates to a systemcomposer.arch.Component, systemcomposer.arch.VariantComponent, systemcomposer.arch.ComponentPort, systemcomposer.arch.ArchitecturePort, systemcomposer.arch.Connector, or systemcomposer.arch.PhysicalConnector object.

More About

Definitions

Term	Definition	Application	More Information
Allocation	An allocation establishes a directed relationship from architectural elements — components, ports, and connectors — in one model to architectural elements in another model.	Resource-based allocation allows you to allocate functional architectural elements to logical architectural elements and logical architectural elements to physical architectural elements.	Create and Manage Allocations Interactively Create and Manage Allocations Programmatically
Allocation scenario	An allocation scenario contains a set of allocations between a source and a target model.	Allocate between model elements in an allocation scenario. The default allocation scenario is called Scenario 1.	Systems Engineering Approach for SoC Applications
Allocation set	An allocation set consists of one or more allocation scenarios that describe various allocations between a source and a target model.	Create an allocation set with allocation scenarios in the Allocation Editor. Allocation sets are saved as MLDATX files.	Establish Traceability Between Architectures and Requirements Allocate Architectures in Tire Pressure Monitoring System

Version History

Introduced in R2020b