allocate

Create new allocation

Syntax

allocation = allocate(allocScenario,sourceElement,targetElement)

Description

allocation = allocate(allocScenario,sourceElement,targetElement) creates a new allocation between the source element sourceElement and target element targetElement.

To remove an allocation, use the deallocate function.

Examples

Create Allocation Set and Allocate Elements Between Models

Create two new models with a component each.

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

Create the allocation set 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);

Save the allocation set.

save(allocSet)

Open the Allocation Editor.

systemcomposer.allocation.editor

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.

targetElement — Target element

element object

Target 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

allocation — Allocation

allocation object

Allocation between source and target element, returned as a systemcomposer.allocation.Allocation 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.	Allocate Architectures in Tire Pressure Monitoring System
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.	Create and Manage Allocations Interactively Create and Manage Allocations Programmatically

Version History

Introduced in R2020b