Main Content

getAllocation

Get allocation between source and target elements

    Description

    example

    allocation = getAllocation(allocScenario,sourceElement,targetElement) gets the allocation, if one exists, between the source element sourceElement and the target element targetElement.

    Examples

    collapse all

    % Create two new models with a component each
    mSource = systemcomposer.createModel('Source_Model_Allocation',true);
    mSource.Architecture.addComponent('Source_Component');
    mTarget = systemcomposer.createModel('Target_Model_Allocation',true);
    mTarget.Architecture.addComponent('Target_Component');
    
    % Create the allocation set with name 'MyNewAllocation'
    allocSet = systemcomposer.allocation.createAllocationSet('MyNewAllocation',...
         'Source_Model_Allocation','Target_Model_Allocation');
    
    % Get the default allocation scenario
    defaultScenario = allocSet.getScenario('Scenario 1');
    
    % Allocate components between models
    allocation = defaultScenario.allocate('Source_Component','Target_Component');
    
    % Get the allocation between the source component and the target component
    allocation = defaultScenario.getAllocation('Source_Component','Target_Component');

    Input Arguments

    collapse all

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

    Output Arguments

    collapse all

    Allocation between source element and target element, returned as a systemcomposer.allocation.Allocation object.

    More About

    collapse all

    Definitions

    TermDefinitionApplicationMore Information
    allocationAn allocation is a directed relationship from an element in one model to an element 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.Allocate Architectures in Tire Pressure Monitoring System
    allocation scenarioAn allocation scenario contains a set of allocations between a source and target model.Allocate between model elements within an allocation in an allocation scenario. The default allocation scenario is called Scenario 1.Create and Manage Allocations
    allocation setAn allocation set consists of one more allocation scenarios which describe various allocations between a source and target model.Create an allocation set with allocation scenarios.Create and Manage Allocations

    Introduced in R2020b