systemcomposer.rptgen.report.AllocationSet class

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

Allocation set reporter

Since R2022b

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

Source — Allocation set result

allocation set result object

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

Summary — Custom summary reporter

reporter object

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

Scenario — Scenarios in allocation set

reporter object

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

IncludeSummary — Whether to include summary table

true or 1 | false or 0

Whether to include summary table, specified as a logical.

Data Types: logical

IncludeScenario — Whether to include allocation scenario table

true or 1 | false or 0

Whether to include allocation scenario table, specified as a logical.

Data Types: logical

TemplateSrc — Source of template for this reporter

[] (default) | character vector | string scalar | reporter or report | DOM document or document part

Source of the template for this reporter, specified as one of these options:

• 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

• 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 this reporter is appended. 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.

TemplateName — Name of template for this reporter

character vector | string scalar

Name of 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 source (TemplateSrc) for this reporter.

LinkTarget — Hyperlink target for this reporter

[] (default) | character vector | string scalar | mlreportgen.dom.LinkTarget object

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

Methods

Public Methods

createTemplate	Create allocation set template
customizeReporter	Create custom allocation set reporter class
getClassFolder	Allocation set class definition file location

Inherited Methods

copy (Simulink Report Generator)	Create copy of a Simulink® reporter object and make deep copies of certain property values
getImpl (Simulink Report Generator)	Get implementation of reporter

Examples

Generate AllocationSet Result Report

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