Main Content

systemcomposer.rptgen.finder.ViewFinder class

Package: systemcomposer.rptgen.finder
Superclasses: mlreportgen.finder.Finder (MATLAB Report Generator)

Description

The systemcomposer.rptgen.finder.ViewFinder class searches for information about all the views in a given System Composer™ architecture model.

Creation

finder = ViewFinder(Container) creates a finder that finds all views in a given model.

Note

This finder provides two ways to get search results:

  1. To return the search results as an array, use the find method. Add the results directly to a report or process the results in a for loop.

  2. To iterate through the results one at a time, use the hasNext and next methods in a while loop.

Neither option has a performance advantage.

Properties

expand all

Architecture model file name without the .slx extension, specified as a string.

Example: f = ViewFinder("ArchModel")

Data Types: string

Type of view, specified as "Default" to display what the view was saved in, "Component Diagram" for component diagram, and "Component Hierarchy" for component hierarchy.

Attributes:

GetAccess
public
SetAccess
public

Data Types: string

Properties of objects to find, specified as a cell array of name-value arguments. The finder returns only objects that have the specified properties with the specified values.

Example: f.Properties = {'Gain','5'}

Data Types: char

Methods

expand all

Examples

collapse all

Use the ViewFinder and ViewResult classes to generate a report.

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

scKeylessEntrySystem
model_name = "KeylessEntryArchitecture";
model = systemcomposer.loadModel(model_name);
rpt = slreportgen.report.Report(output="ViewFinderReport",...
CompileModelBeforeReporting=false);
add(rpt,TitlePage("Title",sprintf('Views in %s Model',model_name)));
add(rpt,TableOfContents);

viewFinder = ViewFinder(model_name);

chapter = Chapter("Title","Views");
while hasNext(viewFinder)
    view = next(viewFinder);
    sect = Section("Title",view.Name);
    add(sect,view);
    add(chapter,sect);
end

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

Version History

Introduced in R2022b