systemcomposer.rptgen.report.Interface Class

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

Interface reporter

Since R2022b

Description

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

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

Creation

reporter = Interface("Source",result) creates a reporter that reports on interfaces in a model using a systemcomposer.rptgen.finder.InterfaceResult object.

Properties

Source — Interface result

interface result object

Interface result, specified as a systemcomposer.rptgen.finder.InterfaceResult object.

Elements — Elements in interface of component

reporter object

Elements in interface of component, specified as a reporter object. The default value is the mlreportgen.report.BaseTable (MATLAB Report Generator) reporter.

PortsUsage — Ports on which interface is present

reporter object

Ports on which interface is present, specified as a reporter object. The default value is the mlreportgen.report.BaseTable (MATLAB Report Generator) reporter.

IncludeElements — Whether to report on elements table

1 (true) | 0 (false)

Whether to report on allocated from list, specified as 1 (true) or 0 (false).

Data Types: logical

IncludePortsUsage — Whether to report on ports usage table

1 (true) | 0 (false)

Whether to report on allocated to list, specified as 1 (true) or 0 (false).

Data Types: logical

TemplateSrc — Source of template for this reporter

character vector | string scalar | reporter or report | DOM document or document part

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.

TemplateName — Name of template for this reporter

character vector | string scalar

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

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 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

Public Methods

createTemplate	Create interface template
customizeReporter	Create custom interface reporter class
getClassFolder	Interface 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 Interface Result Report

Use the InterfaceFinder and InterfaceResult classes to generate a report.

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

scExampleSmallUAV
model_name = "scExampleSmallUAVModel";
model = systemcomposer.loadModel(model_name);
rpt = slreportgen.report.Report(output="InterfaceResultReport",...
CompileModelBeforeReporting=false);
add(rpt,TitlePage("Title",sprintf('Interfaces in %s Model',model_name)));
add(rpt,TableOfContents);
chapter = Chapter("Title","Interfaces");

intfFinder = InterfaceFinder(model_name);
result = find(intfFinder);
for i=1:length(result)
    reporter = getReporter(result(i));
    add(chapter,reporter);
end

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

Version History

Introduced in R2022b