getScenario

Get allocation scenario

Since R2020b

Syntax

scenario = getScenario(allocSet,name)

Description

scenario = getScenario(allocSet,name) gets the allocation scenario in the allocation set allocSet with the given name name, if one exists.

Examples

Create Allocation Set and Get Default Scenario

Create two new models with a 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 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")

defaultScenario = 

  AllocationScenario with properties:

             Name: 'Scenario 1'
      Description: ''
    AllocationSet: [1×1 systemcomposer.allocation.AllocationSet]
      Allocations: [0×0 systemcomposer.allocation.Allocation]
             UUID: '6cde23e8-7c72-4fa0-8f51-e65290208564'

Input Arguments

allocSet — Allocation set

allocation set object

Allocation set, specified as a systemcomposer.allocation.AllocationSet object.

name — Name of allocation scenario

character vector | string

Name of allocation scenario, specified as a character vector or string.

Example: "Scenario 1"

Data Types: char | string

Output Arguments

scenario — Allocation scenario

allocation scenario object

Allocation scenario, returned as a systemcomposer.allocation.AllocationScenario 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