systemcomposer.rptgen.report.View Class

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

View reporter

Since R2022b

Description

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

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

Creation

reporter = View("Source",result) creates a reporter that reports on a view using a systemcomposer.rptgen.finder.ViewResult object.

Properties

Source — View result

view result object

View result, specified as a systemcomposer.rptgen.finder.ViewResult object.

Snapshot — Custom snapshot reporter

reporter object

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

Elements — Elements present in view

reporter object

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

Properties — Custom properties reporter

reporter object

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

SubGroups — Subgroups of view

reporter object

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

IncludeElements — Whether to include elements table

1 (true) | 0 (false)

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

Data Types: logical

IncludeProperties — Whether to include properties table

1 (true) | 0 (false)

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

Data Types: logical

IncludeSubGroups — Whether to include subgroups table

1 (true) | 0 (false)

Whether to include subgroups table, 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 this reporter uses or whose template library contains the template for this reporter

• Document Object Model (DOM) document or document part whose template this reporter uses 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.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

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.

Attributes:

GetAccess	public
SetAccess	public

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.

Attributes:

GetAccess	public
SetAccess	public

Methods

Public Methods

createTemplate	Create view template
customizeReporter	Create custom view reporter class
getClassFolder	View 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

Find Views in Architectures

Use the ViewFinder and ViewResult classes to create a report that finds all views in a given architecture model.

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

Open the scKeylessEntrySystem project.

prj = openProject("scKeylessEntrySystem");
model_name = "KeylessEntryArchitecture";
mdl = systemcomposer.loadModel(model_name);

Create a report and append a title page and table of contents.

viewsReport = slreportgen.report.Report(OutputPath=model_name + "_ViewsReport", ...
    CompileModelBeforeReporting=false);
append(viewsReport,TitlePage(Title="Views in " + model_name));
append(viewsReport,TableOfContents);

Create a chapter to contain all sections related to views in the architecture model.

viewsChapter = Chapter(Title="Views");

Find all views in the architecture model.

viewFinder = ViewFinder(model_name);
while hasNext(viewFinder)
    view = next(viewFinder);
    viewSection = Section(Title=view.Name);
    append(viewSection,view);
    append(viewsChapter,viewSection);
end

Append the chapter to the report and view the generated report.

append(viewsReport,viewsChapter);
close(viewsReport);
rptview(viewsReport);

Version History

Introduced in R2022b