systemcomposer.rptgen.report.DependencyGraph Class

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

Dependency graph reporter

Since R2022b

Description

Create a reporter that reports on a dependency graph for a System Composer™ architecture model artifact.

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

Creation

reporter = DependencyGraph("Source",fullpath) creates a reporter that reports on a dependency graph using the full path of the artifact.

Properties

Source — Full path to artifact

string

Full path to artifact, specified as a string.

Data Types: string

Layout — Alignment of dependency graph

"Vertical" (default) | "Horizontal"

Alignment of dependency graph, specified as "Vertical" for a vertically aligned dependency graph or "Horizontal" for a horizontally aligned dependency graph.

Data Types: string

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.

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 dependency graph template
customizeReporter	Create custom dependency graph reporter class
getClassFolder	Dependency graph 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 DependencyGraph Result Report

Use the DependencyGraph class to generate a report.

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

rpt = slreportgen.report.Report(output="DependencyGraphResultReport",...
CompileModelBeforeReporting=false);
add(rpt,TitlePage("Title","Dependency Graph"));
add(rpt,TableOfContents);
modelName = "mTestModel.slx";

chapter = Chapter("Packaging");
section = Section('Title','Packaging');
reporter = systemcomposer.rptgen.report.DependencyGraph("Source",which(modelName));

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

Version History

Introduced in R2022b