Main Content

systemcomposer.rptgen.finder.FunctionFinder Class

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

Find function objects

Since R2022b

Description

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

Creation

finder = FunctionFinder(Container) creates a finder that finds all functions in a software architecture model. You can specify the functions to find using the Properties property.

Note

This finder provides these options to get search results:

  • 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.

  • 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 filename without the .slx extension, specified as a string.

Example: f = FunctionFinder("ArchModel")

Data Types: string

Component to find functions in, specified as a string of the full path.

Example: f.ComponentName = "mTestModel/Component1"

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 FunctionFinder and FunctionResult classes to generate a report.

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

rpt = slreportgen.report.Report(output="FunctionFinderReport",...
CompileModelBeforeReporting=false);
add(rpt,TitlePage("Title","Software Functions"));
add(rpt,TableOfContents);

functionFinder = FunctionFinder("SoftwareModel");
functionFinder.ComponentName = "Component0";
chapter = Chapter("Title","Functions");
while hasNext(functionFinder)
    functions = next(functionFinder);
    sect = Section("Title",functionFinder.ComponentName);
    add(sect,functions);
    add(chapter,sect);
end

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

Version History

Introduced in R2022b