systemcomposer.rptgen.finder.AllocationListResult Class

Namespace: systemcomposer.rptgen.finder
Superclasses: mlreportgen.finder.Result (MATLAB Report Generator)

Search result for allocations

Since R2022b

Description

Allocation list search result object for a component in a System Composer™ architecture model.

The systemcomposer.rptgen.finder.AllocationListResult class is a handle class.

Creation

result = AllocationListResult creates a search result object for allocations to and from a specific component that you find by using a systemcomposer.rptgen.finder.AllocationListFinder object.

Note

The find method of the systemcomposer.rptgen.finder.AllocationListFinder class creates a search result object for each allocation that it finds. You do not need to create this object yourself.

Properties

Object — Universal unique identifier of result element

string

Universal unique identifier (UUID) of result element, returned as a string.

Data Types: string

AllocatedFrom — Components from which specified component has been allocated

array of strings

Components from which specified component has been allocated, returned as an array of strings.

Data Types: string

AllocatedTo — Components to which specified component has been allocated

array of strings

Components to which specified component has been allocated, returned as an array of strings.

Data Types: string

Tag — Tag to associate with result

string

Tag to associate with result, specified as a string. You can use this property to attach additional information to a result. You can set this property to any value that meets your requirements.

Data Types: string

Methods

Public Methods

getReporter

Get allocation list reporter

Examples

Generate AllocationList Result Report

Use the AllocationListFinder and AllocationListResult classes to generate a report.

import mlreportgen.report.*
import slreportgen.report.*
import systemcomposer.rptgen.finder.*

rpt = slreportgen.report.Report(output="AllocationListResultReport",...
CompileModelBeforeReporting=false);
add(rpt,TitlePage("Title","Allocations"));
add(rpt,TableOfContents);

allocationListFinder = AllocationListFinder("AllocationSet.mldatx");
allocationListFinder.ComponentName = "mTestModel/Component1";
chapter = Chapter("Title",allocationListFinder.ComponentName);
result = find(allocationListFinder);
reporter = getReporter(result);

add(rpt,chapter);
append(rpt,reporter);
close(rpt);
rptview(rpt)

Version History

Introduced in R2022b