Main Content

systemcomposer.rptgen.report.Component class

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

Component reporter

Description

Create a reporter that reports on all components in a System Composer™ architecture model.

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

Creation

reporter = Component("Source",result) creates a reporter that reports on a component using a systemcomposer.rptgen.finder.ComponentResult object.

Properties

expand all

Component result, specified as a systemcomposer.rptgen.finder.ComponentResult object.

Custom snapshot reporter, specified as a reporter object. The default value is the slreportgen.report.Diagram (Simulink Report Generator) reporter.

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

Custom properties reporter for stereotypes on component, specified as a reporter object. The default value is the mlreportgen.report.BaseTable (MATLAB Report Generator) reporter.

Custom properties reporter for ports on component, specified as a reporter object. The default value is the mlreportgen.report.BaseTable (MATLAB Report Generator) reporter.

Custom properties reporter for functions on software component, specified as a reporter object. The default value is the mlreportgen.report.BaseTable (MATLAB Report Generator) reporter.

Child components, specified as an array of systemcomposer.rptgen.report.Component objects.

Data Types: string

Whether to include snapshot table, specified as a logical.

Data Types: logical

Whether to include properties table, specified as a logical.

Data Types: logical

Whether to include stereotypes table, specified as a logical.

Data Types: logical

Whether to include ports table, specified as a logical.

Data Types: logical

Whether to include functions table, specified as a logical.

Data Types: logical

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.

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.

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

expand all

Examples

collapse all

Use the ComponentFinder and ComponentResult classes to generate a report.

import systemcomposer.rptgen.finder.*
import mlreportgen.report.*
import slreportgen.report.*
import systemcomposer.query.*

rpt = slreportgen.report.Report(output="ComponentResultReport",...
CompileModelBeforeReporting=false);
add(rpt,TitlePage("Title","Components"));
add(rpt,TableOfContents);
chapter = Chapter("Title","Components");

componentFinder = ComponentFinder("mTestModel");
componentFinder.Query = AnyComponent;
result = find(componentFinder);

for i = result
    reporter = getReporter(i);
    reporter.IncludeProperties = false;
    reporter.IncludeSnapshot = false;
    add(chapter,reporter);
end

add(rpt,chapter);
close(rpt);
rptview(rpt);

Version History

Introduced in R2022b