slreportgen.utils.HierarchyNumber Class

R2026b

Namespace: slreportgen.utils

Generate number that represents subsystem position in model hierarchy

expand all in page

Description

Use an object of the slreportgen.utils.HierarchyNumber class to generate numbers that represent the positions of subsystems in a model hierarchy. You can use the numbers to label report elements, such as section titles.

The slreportgen.utils.HierarchyNumber class is a handle class.

Class Attributes

HandleCompatible
true

For information on class attributes, see Class Attributes.

Creation

Description

hierarchyNumberObj = slreportgen.utils.HierarchyNumber(source) creates a hierarchy number object for the specified source and sets the Source property to source.

If you specify the source as a Simulink® model, the HierarchyNumber object uses all the uncommented Simulink subsystems and Stateflow® chart diagrams in the model to generate the model hierarchy numbers. Otherwise, the object uses the custom subsystem list that you specify. For example, to generate the hierarchy number of Stateflow chart diagrams in a model, specify a list of the subsystem paths.

example

Properties

expand all

Model or subsystem, specified as one of these values:

  • character vector or string scalar that contains the name of an open or loaded model

  • Handle of an open or loaded model

  • String array of subsystem paths

  • Cell array of subsystem paths or handles

Attributes:

SetAccess
private

Methods

expand all

Examples

collapse all

Generate the hierarchy number for the Aircraft Dynamics Model subsystem in the slrgex_pitch_control model.

modelName = "slrgex_pitch_control";
openExample(modelName)
hierNumberObj = slreportgen.utils.HierarchyNumber(modelName);
hierNumber = generateHierarchyNumber(hierNumberObj, ...
    "slrgex_pitch_control/Aircraft Dynamics Model")
hierNumber =
"1.1"

Generate hierarchy numbers for diagrams in the slrgex_pitch_control model and use them in report section titles.

Import the namespaces so that you do not have to use long, fully-qualified class names.

import mlreportgen.dom.*;
import mlreportgen.report.*;
import slreportgen.finder.*;
import slreportgen.utils.*;

Load a model.

model = "slrgex_pitch_control";
openExample(model)

Create a report. Turn off numbering for the report sections.

rpt = Report("output","pdf");
open(rpt);
mlreportgen.report.Section.number(rpt,false);

Create the table of contents and add it to the report.

toc = TableOfContents();
append(rpt,toc);

Create a chapter and turn on chapter numbering.

chapter = Chapter(model + " Model");
chapter.Numbered = true;

Create a diagram finder and a HierarchyNumber object for the model.

finder = DiagramFinder(model);
hierNumberObj = HierarchyNumber(model);

For each found diagram, generate the number that represents the relative position of the diagram in the model hierarchy. Create a section for the diagram and use the generated number in the title. Turn off the default section numbering. Append the section to the chapter.

while hasNext(finder)
    result = next(finder);
    hierNumber = hierNumberObj.generateHierarchyNumber(result.Path);
    title = strcat (hierNumber + " " + result.Name);
    section = Section(title);
    section.Numbered = false;
    append(chapter, section);
end

Append the chapter to the report.

append(rpt,chapter);

Close and view the report.

close(rpt);
rptview(rpt);

Snippet of report table of contents showing the first chapter and the first four chapter sections.

Version History

Introduced in R2021b

See Also

|