Main Content

getAllocatedFrom

Get allocation source

Since R2020b

    Description

    sourceElements = getAllocatedFrom(allocScenario,targetElement) gets all allocated source elements from which a target element targetElement is allocated.

    example

    Examples

    collapse all

    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 from source component allocated to target component.

    sourceElement = getAllocatedFrom(defaultScenario,targetComp)
    sourceElement = 
    
      Component with properties:
    
         IsAdapterComponent: 0
               Architecture: [1×1 systemcomposer.arch.Architecture]
                       Name: 'Source_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: 2.0001
        SimulinkModelHandle: 1.2207e-04
                       UUID: 'c5ab7c89-3ebc-4a19-934b-9b0f473a0737'
                ExternalUID: ''

    Input Arguments

    collapse all

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

    Output Arguments

    collapse all

    Source elements from which specified target element is allocated, returned 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

    collapse all

    Version History

    Introduced in R2020b