getReporter

Class: systemcomposer.rptgen.finder.FunctionResult
Namespace: systemcomposer.rptgen.finder

Get function reporter

Since R2022b

Syntax

reporter = getReporter(result)


Description

reporter = getReporter(result) returns a reporter that you can use to include information about functions in a software architecture model. You can use this reporter to customize what information to include and how to format the information. See systemcomposer.rptgen.report.Function for more information on how to customize the reporter.

Input Arguments

result — Function result

function result object

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

Output Arguments

reporter — Function reporter

function reporter object

Function reporter, returned as a systemcomposer.rptgen.report.Function 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