slreportgen.report.SystemHierarchy Class

Namespace: slreportgen.report
Superclasses: slreportgen.report.Reporter

System hierarchy reporter

Description

Creates a system hierarchy reporter that generates a nested list of the subsystems of a Simulink^® model or subsystem in a report.

Note

To use a system hierarchy reporter in a report, you must create the report using the slreportgen.report.Report class or subclass.

The slreportgen.report.SystemHierarchy class is a handle class.

Class Attributes

HandleCompatible

true

For information on class attributes, see Class Attributes.

Creation

Description

rptr = slreportgen.report.SystemHierarchy creates an empty system hierarchy reporter based on a default template. Customize the content and format of the generated list by using the reporter properties. Before you add the reporter to a report, you must specify a model or subsystem in the Source property of the reporter. Adding an empty reporter to a report produces an error.

rptr = slreportgen.report.SystemHierarchy(source) creates a system hierarchy reporter for the model or subsystem specified by source. See the Source property.

rptr = slreportgen.report.SystemHierarchy(>PropertyName=Value) sets the reporter properties using name-value arguments. You can specify multiple name-value arguments in any order.

Properties

Source — Simulink model or subsystem

[] (default) | string scalar | character vector | handle

Simulink model or subsystem, specified as a character vector or string scalar that contains the path to the model or subsystem, or as a handle to the model or subsystem.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

MaxAncestorLevel — Maximum number of levels of ancestors to include

Inf (default) | nonnegative integer scalar

Maximum number of levels of ancestors of the source subsystem to include in the generated list, specified as a nonnegative integer scalar. For example, if MaxAncestorLevel is 2, the list includes the source and up to two levels of ancestors. If MaxAncestorLevel is Inf, the default value, the list includes all ancestors. If MaxAncestorLevel is zero, the list does not include ancestors.

Attributes:

GetAccess	public
SetAccess	public

Data Types: double

MaxDescendantLevel — Maximum number of levels of descendants to include

Inf (default) | nonnegative integer scalar

Maximum number of levels of descendants of the source model or subsystem to include in the generated list, specified as a nonnegative integer scalar. For example, if MaxDescendantLevel is 2, the list includes the source and up to two levels of descendants. If MaxDescendantLevel is Inf, the default value, the list includes all descendants. If MaxDescendantLevel is zero, the list does not include descendants.

Attributes:

GetAccess	public
SetAccess	public

Data Types: double

IncludePeers — Whether to include peers of subsystem

1 (true) (default) | 0 (false)

Whether to include peers of the source subsystem in the generated list, specified as a logical 1 (true) or 0 (false). When you specify:

• 1 (true) — Include peers of the source subsystem in the generated list.

• 0 (false) — Omit peers of the source subsystem in the generated list.

Attributes:

GetAccess	public
SetAccess	public

Data Types: logical

EmphasizeSource — Whether to emphasize the source

1 (true) (default) | 0 (false)

Whether to emphasize the source model or subsystem in the generated list, specified as a logical 1 (true) or 0 (false). When you specify:

• 1 (true) — Format the name of the source model or subsystem according to the TextFormatter property.

• 0 (false) — Format the name of the source model or subsystem like the other items in the list.

Attributes:

GetAccess	public
SetAccess	public

Data Types: logical

ListFormatter — List formatter for referenced dictionary list

mlreportgen.dom.UnorderedList object | mlreportgen.dom.OrderedList object

List formatter for a referenced dictionary list, specified as an mlreportgen.dom.UnorderedList object or mlreportgen.dom.OrderedList object. The list formatter is used when the ReferencedDictionaryPolicy property is set to "List". The UnorderedList or OrderedList object must not contain list items.

The default value of this property is an UnorderedList object with the StyleName property set to the SystemHierarchyList style, which is defined in the default template of a SystemHierarchy reporter. To customize the appearance of the list, modify the properties of the default UnorderedList object or replace the object with your own UnorderedList or OrderedList object.

Attributes:

GetAccess	public
SetAccess	public

ListFormatter — List formatter

mlreportgen.dom.UnorderedList (default) | mlreportgen.dom.OrderedList

List formatter that formats the generated list, specified as an mlreportgen.dom.UnorderedList object or an mlreportgen.dom.OrderedList object. The default value of this property is an object of mlreportgen.dom.UnorderedList. To customize the list formatting, modify the list object properties or replace the list object with a customized list object that does not contain list items.

Attributes:

GetAccess	public
SetAccess	public

SourceTextFormatter — Text formatter for highlighting the name of the source

mlreportgen.dom.Text

Text formatter object that formats the name of the source model or subsystem in the generated list, specified as an mlreportgen.dom.Text object. This property applies only if the EmphasizeSource property is true. The initial value of the SourceTextFormatter property is an mlreportgen.dom.Text object with the Bold and Italic properties set to true. To customize the appearance of the name in the generated list, modify the mlreportgen.dom.Text object properties or replace the object with a customized mlreportgen.dom.Text object. If you add text to the default or replacement text object, the text appears in front of the source name in the generated report.

Attributes:

GetAccess	public
SetAccess	public

IncludeMaskedSubsystems — Whether to include masked subsystems

0 (false) (default) | 1 (true)

Whether the generated list of descendants of the source system includes masked subsystems, specified as a logical 1 (true) or 0 (false). When you specify:

• 1 (true) — Include masked subsystems and their descendant subsystems, as long as the number of levels below the source subsystem is less than or equal to the value of the MaxDescendantLevel property.

  To enable the system hierarchy reporter to link masked subsystems to the corresponding diagrams in the report, in the diagram reporter, set the MaskedSystemLinkPolicy property to "system".

• 0 (false) — Omit masked subsystems and their descendant subsystems.

Attributes:

GetAccess	public
SetAccess	public

Data Types: logical

IncludeReferencedModels — Whether to include referenced models

1 (true) (default) | 0 (false)

Whether the generated list of descendants of the source system includes referenced models, specified as a logical 1 (true) or 0 (false). When you specify:

• 1 (true) — Include referenced models and their descendant subsystems, as long as the number of levels below the source subsystem is less than or equal to the value of the MaxDescendantLevel property.

• 0 (false) — Omit referenced models and their descendant subsystems.

Attributes:

GetAccess	public
SetAccess	public

Data Types: logical

IncludeReferencedSubsystems — Whether to include referenced subsystems

1 (true) (default) | 0 (false)

Whether the generated list of descendants of the source system includes referenced subsystems, specified as a logical 1 (true) or 0 (false). When you specify:

• 1 (true) — Include referenced subsystems and their descendant subsystems, as long as the number of levels below the source subsystem is less than or equal to the value of the MaxDescendantLevel property.

• 0 (false) — Omit referenced subsystems and their descendant subsystems.

Attributes:

GetAccess	public
SetAccess	public

Data Types: logical

IncludeSimulinkLibraryLinks — Whether to include Simulink library links

1 (true) (default) | 0 (false)

Whether the generated list of descendants of the source system includes subsystems that link to a Simulink library subsystem, specified as a logical 1 (true) or 0 (false). When you specify:

• 1 (true) — Include a linked subsystem or one of its descendant subsystems that link to a Simulink library subsystem, if all of these conditions are true:

  • the value of IncludeSimulinkLibraryLinks is true.

  • the subsystem is not masked, or the subsystem is masked and the value of the IncludeMaskedSubsystems property is true.

  • the number of levels below the source subsystem is less than or equal to the value of the MaxDescendantLevel property.

• 0 (false) — Omit the generated list of descendants of the source system includes subsystems that link to a Simulink library subsystem.

Data Types: logical

IncludeUserLibraryLinks — Whether to include library links to user-defined libraries

1 (true) (default) | 0 (false)

Whether the generated list of descendants of the source system includes subsystems that link to a user-defined library subsystem, specified as a logical 1 (true) or 0 (false). When you specify:

• 1 (true) — Include a linked subsystem or one of its descendant subsystems that link to a user-defined library subsystem, if all of these conditions are true:

  • the value of IncludeUserLibraryLinks is true.

  • the subsystem is not masked, or the subsystem is masked and the value of the IncludeMaskedSubsystems property is true.

  • the number of levels below the source subsystem is less than or equal to the value of the MaxDescendantLevel property.

• 0 (false) — Omit the generated list of descendants of the source system includes subsystems that link to a user-defined library subsystem.

Attributes:

GetAccess	public
SetAccess	public

Data Types: logical

IncludeVariants — Variants to include

"Active" (default) | "All" | "ActivePlusCode"

Variants of a variant block to include in the generated list of descendants of the source system, specified as one of these values:

Value	Description
"Active"	Active variants
"All"	All variants
"ActivePlusCode"	Active variants and code variants

The list includes the variants only if the number of levels below the source subsystem is less than or equal to the value of the MaxDescendantLevel property. When IncludeVariants is specified as "All", the report displays inactive variant links using a different style (since R2026a) than the active variant links. Active variant links display in blue and inactive variant links display in grey italic.

Note

If you have not compiled the model before generating the report, the report includes all variants regardless of the specified value of this property.

Attributes:

GetAccess	public
SetAccess	public

Data Types: char | string

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

Method	Purpose
slreportgen.report.SystemHierarchy.createTemplate	Create reporter template template = createTemplate(templatePath,templateType) creates a copy of the default template for the report type specified by templateType at the location specified by templatePath. You can use the copied template as a starting point to design a custom reporter template for your report. Input Arguments templatePath — Target path and file name for template file, specified as a character vector or a string scalar. templateType — Template type, specified as "html", "docx", or "pdf" Return Values template — Path and file name of the template copy, returned as a string scalar For more information, see the method for the Reporter class, slreportgen.report.Reporter.createTemplate.
slreportgen.report.SystemHierarchy.customizeReporter	Create reporter from slreportgen.report.SystemHierarchy class classPathOut = customizeReporter(classPath) creates a reporter class definition file that defines a subclass of slreportgen.report.SystemHierarchy at the location specified by classPath. The method copies the default reporter templates to the resources/templates subfolder of the folder that contains the class definition file. You can use the class definition file as a starting point to design a custom reporter class. Input Arguments classPath — Path and name of the new class definition file, specified as a character vector or string scalar Return Values classPathOut — Path and file name of the new class, returned as a string scalar For more information, see the method for the slreportgen.report.Reporter class, slreportgen.report.Reporter.customizeReporter.
slreportgen.report.SystemHierarchy.getClassFolder	Get location of folder that contains slreportgen.report.SystemHierarchy class definition file path = getClassFolder returns the path of the folder that contains the class definition file. Return Values path — Class definition file location, returned as a character vector For more information, see the method for the Reporter class, slreportgen.report.Reporter.getClassFolder.
copy	Create copy of reporter object and make deep copies of property values copiedObj = copy(reporterObj) returns a copy of the specified reporter object. The returned copy contains a deep copy of any property value of reporterObj that references a reporter, DOM object, or slreportgen.report.ReporterLayout object.As a result, you can modify the properties of the original or new object without affecting the other object. Input Arguments reporterObj — Reporter object to copy, specified as an object of a reporter class Return Values copiedObj — Copy of reporter, returned as an object of a reporter class For more information, see the method for the slreportgen.report.Reporter class, copy.
getImpl	Get implementation of reporter impl = getImpl(reporter,report) returns the Document Object Model (DOM) object that implements the reporter, reporter, when you append it to the report, report. Note You cannot add content to the reporter after calling this method. Input Arguments reporterObj— Reporter object, specified as an object of slreportgen.report.Reporter or an object of a subclass of slreportgen.report.Reporter report — Report, specified as a mlreportgen.report.Report object Return Values impl — Implementation object, returned as a DOM object. For more information, see the method for the slreportgen.report.Reporter class, getImpl.

Examples

Include System Hierarchy of a Model in a Report

Include the system hierarchy of the sldemo_fuelsys model in a report by adding an slreportgen.report.SystemHierarchy reporter to a report generation program. Generate the model diagrams by adding an slreportgen.finder.DiagramFinder object. The system hierarchy reporter generates links from subsystems in the nested list to the corresponding diagrams.

Import the API packages.

import slreportgen.report.*
import mlreportgen.report.*
import mlreportgen.dom.*

Load the model.

model = "sldemo_fuelsys";
load_system(model);

Create a report.

rpt = slreportgen.report.Report("output","pdf");

Create a chapter reporter.

chapter = Chapter("System Hierarchy for the " + model + " Model");

Create a System Hierarchy reporter for the model.

rptr = SystemHierarchy(model);

Add the System Hierarchy reporter to the chapter. Then add the chapter to the report.

add(chapter, rptr);
add(rpt, chapter);

Find the diagrams for the subsystems.

finder = slreportgen.finder.DiagramFinder(model);
while hasNext(finder)
    result = next(finder);
    ch = Chapter(result.Name);
    add(ch, result);
    add(rpt, ch);
end

Close and view the output report.

close(rpt);
close_system(model);
rptview(rpt);

In the generated report, the system hierarchy lists the subsystems under the sldemo_fuelsys model.

To see the diagram corresponding to a subsystem, click the subsystem in the list.

Version History

Introduced in R2019b

R2026a: Visually differentiate inactive variant links with a different text style

When IncludeVariants is specified as "All", the report displays inactive variant links using a different style than the active variant links. Active variant links display in blue and inactive variant links display in grey italic.