getReporter

Class: systemcomposer.rptgen.finder.AllocationListResult
Package: systemcomposer.rptgen.finder

Get allocation list reporter

Since R2022b

Syntax

reporter = getReporter(result)


Description

reporter = getReporter(result) returns a reporter that is used to include information about allocations in a component. You can use this reporter to customize what information is included and how the information is formatted. See the systemcomposer.rptgen.report.AllocationList reporter class for more information on how to customize the reporter.

Input Arguments

result — Allocation list result

allocation list result object

Allocation list result, specified as a systemcomposer.rptgen.finder.AllocationListResult object.

Output Arguments

reporter — Allocation list reporter

allocation list reporter object

Allocation list reporter, returned as a systemcomposer.rptgen.report.AllocationList object.

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