Main Content

systemcomposer.rptgen.finder.AllocationSetResult Class

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

Search result for allocation sets

Since R2022b

expand all in page

Description

Allocation set search result object in a System Composer™ architecture model.

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

Creation

result = AllocationSetResult creates a search result object for an allocation set that you find by using a systemcomposer.rptgen.finder.AllocationSetFinder object.

Note

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

Properties

expand all

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

Data Types: string

Name of allocation set, returned as a string.

Data Types: string

Source model of allocation set, returned as a string.

Data Types: string

Target model of allocation set, returned as a string.

Data Types: string

Description of allocation set, returned as a string.

Data Types: string

Scenarios present in allocation set, returned as a structure with fields:

  • Name, returned as a string.

  • Allocations, returned as a structure with fields:

    • SourceElement, returned as the fully qualified name of the source component allocated from.

    • TargetElement, returned as the fully qualified name of the target component allocated to.

  • UUID, or universal unique identifier of the scenario, returned a s string.

Data Types: struct

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

expand all

Examples

collapse all

This example uses:

Open Live Script

Use the AllocationSetFinder and AllocationSetResult classes to generate a report.

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

rpt = slreportgen.report.Report(output="AllocationSetResultReport",...
CompileModelBeforeReporting=false);
add(rpt,TitlePage("Title","Allocation Sets"));
add(rpt,TableOfContents);
chapter = Chapter("Title","Allocation Sets");

allocationSetFinder = AllocationSetFinder("AllocationSet.mldatx");
result = find(allocationSetFinder);
reporter = getReporter(result);

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

Version History

Introduced in R2022b

See Also

Classes

Topics