systemcomposer.rptgen.report.AllocationList class

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

Allocation list reporter

Since R2022b

Description

Create a reporter that reports on all the components to and from which a particular component has been allocated in a System Composer™ architecture model.

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

Creation

reporter = AllocationList("Source",result) creates a reporter that reports on allocations around the component defined by the ComponentName property using a systemcomposer.rptgen.finder.AllocationListResult object.

Properties

Source — Allocation list result

allocation list result object

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

AllocatedFrom — Component from which specified component has been allocated

ordered list object

Component from which specified component has been allocated, specified as an mlreportgen.dom.OrderedList (MATLAB Report Generator) object.

AllocatedTo — Component to which specified component has been allocated

ordered list object

Component to which specified component has been allocated, specified as an mlreportgen.dom.OrderedList (MATLAB Report Generator) object..

IncludeAllocatedFrom — Whether to report on allocated-from list

true or 1 | false or 0

Whether to report on allocated-from list, specified as a logical.

Data Types: logical

IncludeAllocatedTo — Whether to report on allocated-to list

true or 1 | false or 0

Whether to report on allocated-to list, 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 list template
customizeReporter	Create custom allocation list reporter class
getClassFolder	Allocation list 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 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