systemcomposer.allocation.AllocationSet

Set of allocation scenarios

Since R2020b

expand all in page

    Description

    An AllocationSet object defines a collection of allocation scenarios between two System Composer™ models.

    Creation

    Create an allocation set with name myNewAllocation using the systemcomposer.allocation.createAllocationSet function.

    systemcomposer.allocation.createAllocationSet("myNewAllocation", ...
     "Source_Model_Allocation","Target_Model_Allocation");

    Properties

    expand all

    Name of allocation set, specified as a character vector.

    Example: 'MyNewAllocation'

    Data Types: char

    Source model for allocation, specified as a systemcomposer.arch.Model object.

    Target model for allocation, specified as a systemcomposer.arch.Model object.

    Allocation scenarios, specified as an array of systemcomposer.allocation.AllocationScenario objects.

    Description of allocation set, specified as a character vector.

    Data Types: char

    Name of default stereotype to apply to allocations in allocation set, specified in the form "<profile>.<stereotype>". The profile must already be imported into the allocation set.

    Data Types: char | string

    Whether allocation set is out of date with the source model, target model, or both, specified as 1 (true) or 0 (false).

    Data Types: logical

    Whether allocation set has unsaved changes, specified as 1 (true) or 0 (false).

    Data Types: logical

    Universal unique identifier, specified as a character vector.

    Example: '91d5de2c-b14c-4c76-a5d6-5dd0037c52df'

    Data Types: char

    Object Functions

    applyProfileApply profile to model
    removeProfileRemove profile from model
    createScenarioCreate new empty allocation scenario
    getScenarioGet allocation scenario
    deleteScenarioDelete allocation scenario
    synchronizeChangesSynchronize changes of models in allocation set
    findFind loaded allocation set
    saveSave allocation set as file
    rebindSourceModelChange source model
    rebindTargetModelChange target model
    closeClose allocation set
    closeAllClose all open allocation sets

    Examples

    collapse all

    Open Live Script

    Use allocations to analyze a tire pressure monitoring system.

    Overview

    In systems engineering, it is common to describe a system at different levels of abstraction. For example, you can describe a system in terms of its high-level functions. These functions may not have any behavior associated with them but most likely trace back to some operating requirements the system must fulfill. We refer to this layer (or architecture) as the functional architecture. In this example, an automobile tire pressure monitoring system is described in three different architectures:

    1. Functional Architecture — Describes the system in terms of its high-level functions. The connections show dependencies between functions [1].

    2. Logical Architecture — Describes the system in terms of its logical components and how data is exchanged between them. Additionally, this architecture specifies behaviors for model simulation [2].

    3. Platform Architecture — Describes the physical hardware needed for the system at a high level [3].

    Note: This example illustrates allocations in System Composer™ using a specific methodology. However, you can use other methodologies that fit your needs.

    The allocation process is defined as linking these three architectures that fully describe the system. The linking captures the information about each architectural layer and makes it accessible to the others.

    Use this command to open the project.

    openProject("scExampleTirePressureMonitorSystem");

    Tire pressure monitoring system example model.

    Open the FunctionalAllocation.mldatx file, which displays allocations from TPMS_FunctionalArchitecture to TPMS_LogicalArchitecture in the Allocation Editor. The elements of TPMS_FunctionalArchitecture are displayed in the first column. The elements of TPMS_LogicalArchitecture are displayed in the first row. The arrows indicate the allocations between model elements.

    Tire pressure example allocation scenario.

    The arrows display allocated components in the model. You can observe allocations for each element in the model hierarchy.

    The rest of the example shows how to use this allocation information to further analyze the model.

    Functional to Logical Allocation and Coverage Analysis

    This section shows how to perform coverage analysis to verify that all functions have been allocated. This process requires using the allocation information specified between the functional and logical architectures.

    To start the analysis, load the allocation set.

    allocSet = systemcomposer.allocation.load('FunctionalAllocation');
scenario = allocSet.Scenarios;

    Verify that each function in the system is allocated.

    import systemcomposer.query.*;
[~,allFunctions] = allocSet.SourceModel.find(HasStereotype(IsStereotypeDerivedFrom("TPMSProfile.Function")));
unAllocatedFunctions = [];
ImplementedAllocations = [];
for i = 1:numel(allFunctions)
    alloc = scenario.getAllocatedTo(allFunctions(i));
    if isempty(alloc)
        unAllocatedFunctions(end+1) = allFunctions(i);
    end
end

allCompsSource = allocSet.SourceModel.find(AnyComponent);
allCompsTarget = allocSet.TargetModel.find(AnyComponent);
for i = 1:numel(allCompsSource)
    for j = 1:numel(allCompsTarget)
        sourceComp = allocSet.SourceModel.lookup(Path=allCompsSource{i});
        targetComp = allocSet.TargetModel.lookup(Path=allCompsTarget{j});
        allocated = scenario.getAllocation(sourceComp,targetComp);
        if ~isempty(allocated)
            if allocated.getPropertyValue("TPMSProfile.FunctionalAllocation.IsImplemented")
                ImplementedAllocations(end+1) = strcat(sourceComp.Name," to ",targetComp.Name);
            end
        end
    end
end

if isempty(unAllocatedFunctions)
  fprintf('All functions are allocated');
else
  fprintf('%d Functions have not been allocated',numel(unAllocatedFunctions));
end

if isempty(ImplementedAllocations)
  fprintf('No allocations are implemented');
else
  fprintf('%d Allocations have been implemented',numel(ImplementedAllocations));
end

    The result displays All functions are allocated to verify that all functions in the system are allocated and lists the allocations that have not been implemented.

    Analyze Suppliers Providing Functions

    This section shows how to identify which functions will be provided by which suppliers using the specified allocations. Since suppliers will be delivering these components to the system integrator, the supplier information is stored in the logical model.

    suppliers = {'Supplier A','Supplier B','Supplier C','Supplier D'};
functionNames = arrayfun(@(x) x.Name, allFunctions,'UniformOutput',false);
numFunNames = length(allFunctions);
numSuppliers = length(suppliers);
allocTable = table('Size',[numFunNames,numSuppliers],'VariableTypes',...
  repmat("double",1,numSuppliers));
allocTable.Properties.VariableNames = suppliers;
allocTable.Properties.RowNames = functionNames;
for i = 1:numFunNames
  elem = scenario.getAllocatedTo(allFunctions(i));
  for j = 1:numel(elem)
      elemSupplier = getEvaluatedPropertyValue(elem(j),'TPMSProfile.LogicalComponent.Supplier');
      allocTable{i,strcmp(elemSupplier,suppliers)} = 1;
  end

end

    The table shows which suppliers are responsible for the corresponding functions.

    allocTable

    Analyze Software Deployment Strategies

    You can determine if the Engine Control Unit (ECU) has enough capacity to house all the software components. The software components are allocated to the cores themselves, but the ECU is the component that has the budget property.

    Get the platform architecture.

    platformArch = systemcomposer.loadModel('PlatformArchitecture');

    Load the allocation.

    softwareDeployment = systemcomposer.allocation.load('SoftwareDeployment');

frontECU = platformArch.lookup('Path','PlatformArchitecture/Front ECU');
rearECU = platformArch.lookup('Path','PlatformArchitecture/Rear ECU');

scenario1 = softwareDeployment.getScenario('Scenario 1');
scenario2 = softwareDeployment.getScenario('Scenario 2');
frontECU_availMemory = getEvaluatedPropertyValue(frontECU,"TPMSProfile.ECU.MemoryCapacity");
rearECU_availMemory = getEvaluatedPropertyValue(rearECU,"TPMSProfile.ECU.MemoryCapacity");

frontECU_memoryUsed1 = getUtilizedMemoryOnECU(frontECU,scenario1);
frontECU_isOverBudget1 = frontECU_memoryUsed1 > frontECU_availMemory;
rearECU_memoryUsed1 = getUtilizedMemoryOnECU(rearECU,scenario1);
rearECU_isOverBudget1 = rearECU_memoryUsed1 > rearECU_availMemory;

frontECU_memoryUsed2 = getUtilizedMemoryOnECU(frontECU,scenario2);
frontECU_isOverBudget2 = frontECU_memoryUsed2 > frontECU_availMemory;
rearECU_memoryUsed2 = getUtilizedMemoryOnECU(rearECU,scenario2);
rearECU_isOverBudget2 = rearECU_memoryUsed2 > rearECU_availMemory;

    Build a table to showcase the results.

    softwareDeploymentTable = table([frontECU_memoryUsed1;frontECU_availMemory;...
  frontECU_isOverBudget1;rearECU_memoryUsed1;rearECU_availMemory;rearECU_isOverBudget1],...
  [frontECU_memoryUsed2; frontECU_availMemory; frontECU_isOverBudget2;rearECU_memoryUsed2;...
  rearECU_availMemory; rearECU_isOverBudget2],...
  'VariableNames',{'Scenario 1','Scenario 2'},...
  'RowNames',{'Front ECUMemory Used (MB)','Front ECU Memory (MB)','Front ECU Overloaded',...
  'Rear ECU Memory Used (MB)','Rear ECU Memory (MB)','Rear ECU Overloaded'})
    function memoryUsed = getUtilizedMemoryOnECU(ecu, scenario)

    For each component in the ECU, accumulate the binary size required for each allocated software component.

    coreNames = {'Core1','Core2','Core3','Core4'};
memoryUsed = 0;
for i = 1:numel(coreNames)
  core = ecu.Model.lookup('Path',[ecu.getQualifiedName '/' coreNames{i}]);
  allocatedSWComps = scenario.getAllocatedFrom(core);
  for j = 1:numel(allocatedSWComps)
      binarySize = getEvaluatedPropertyValue(allocatedSWComps(j),"TPMSProfile.SWComponent.BinarySize");
      memoryUsed = memoryUsed + binarySize;
  end
end
end

    More About

    expand all

    Version History

    Introduced in R2020b

    See Also

    Tools

    Blocks

    Objects

    Functions

    Topics