find

Class: systemcomposer.rptgen.finder.ComponentFinder
Namespace: systemcomposer.rptgen.finder

Find information about component

Since R2022b

Syntax

result = find(finder)


Description

result = find(finder) finds information about a component for the Component search result.

Input Arguments

finder — Component finder

component finder object

Component finder, specified as a systemcomposer.rptgen.finder.ComponentFinder object.

Output Arguments

result — Component result

component result object | array of component result objects

Component result, returned as a systemcomposer.rptgen.finder.ComponentResult object or an array of systemcomposer.rptgen.finder.ComponentResult objects.

Examples

Generate Component Result Report

Use the ComponentFinder and ComponentResult classes to generate a report.

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

rpt = slreportgen.report.Report(output="ComponentResultReport",...
CompileModelBeforeReporting=false);
add(rpt,TitlePage("Title","Components"));
add(rpt,TableOfContents);
chapter = Chapter("Title","Components");

componentFinder = ComponentFinder("mTestModel");
componentFinder.Query = AnyComponent;
result = find(componentFinder);

for i = result
    reporter = getReporter(i);
    reporter.IncludeProperties = false;
    reporter.IncludeSnapshot = false;
    add(chapter,reporter);
end

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

Version History

Introduced in R2022b