find

Class: systemcomposer.rptgen.finder.FunctionFinder
Namespace: systemcomposer.rptgen.finder

Find information about function

Since R2022b

Syntax

result = find(finder)


Description

result = find(finder) finds information about a function for the Function search result.

Input Arguments

finder — Function finder

function finder object

Function finder, specified as a systemcomposer.rptgen.finder.FunctionFinder object.

Output Arguments

result — Function result

function result object

Function result, returned as a systemcomposer.rptgen.finder.FunctionResult object.

Examples

Generate Function Result Report

Use the FunctionFinder and FunctionResult classes to generate a report.

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

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");
result = find(functionFinder);
functionsTable = Function("Source",result);

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

Version History

Introduced in R2022b