Main Content

getReporter

Class: systemcomposer.rptgen.finder.AllocationSetResult
Package: systemcomposer.rptgen.finder

Get allocation set reporter

Since R2022b

Syntax

reporter = getReporter(result)

Description

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

Input Arguments

expand all

Allocation set result, specified as a systemcomposer.rptgen.finder.AllocationSetResult object.

Output Arguments

expand all

Allocation set reporter, returned as a systemcomposer.rptgen.report.AllocationSet object.

Examples

expand all

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