Main Content

systemcomposer.rptgen.report.AllocationSet Class

Namespace: systemcomposer.rptgen.report
Superclasses: slreportgen.report.Reporter (Simulink Report Generator)

Allocation set reporter

Since R2022b

expand all in page

Description

Create a reporter that reports on an allocation set file used between System Composer™ models.

The systemcomposer.rptgen.report.AllocationSet class is a handle class.

Creation

reporter = AllocationSet("Source",result) creates a reporter that reports on an allocation set using a systemcomposer.rptgen.finder.AllocationSetResult object specified by "Source".

Properties

expand all

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

Custom summary reporter, specified as a reporter object. The default value is the mlreportgen.report.BaseTable (MATLAB Report Generator) reporter.

Scenarios in allocation set, specified as a reporter object. The default value is the mlreportgen.report.BaseTable (MATLAB Report Generator) reporter.

Whether to include summary table, specified as 1 (true) or 0 (false).

Data Types: logical

Whether to include allocation scenario table, specified as 1 (true) or 0 (false).

Data Types: logical

Source of the template for this reporter, specified in one of these ways:

  • Character vector or string scalar that specifies the path of the file that contains the template for this reporter

  • Reporter or report whose template is used for this reporter or whose template library contains the template for this reporter

  • Document Object Model (DOM) document or document part whose template is used for this reporter or whose template library contains the template for this reporter

The specified template must be the same type as the report to which you append this reporter. For example, for a Microsoft® Word report, TemplateSrc must be a Word reporter template. If the TemplateSrc property is empty, this reporter uses the default reporter template for the output type of the report.

Name of the template for this reporter, specified as a character vector or string scalar. The template for this reporter must be in the template library of the template specified by the TemplateSrc property of this reporter.

Data Types: char | string

Hyperlink target for this reporter, specified as a character vector or string scalar that specifies the link target ID, or an mlreportgen.dom.LinkTarget (MATLAB Report Generator) object. A character vector or string scalar value converts to a LinkTarget object. The link target immediately precedes the content of this reporter in the output report.

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