getReporter

Class: systemcomposer.rptgen.finder.RequirementLinkResult
Namespace: systemcomposer.rptgen.finder

Get requirement links reporter

Since R2022b

expand all in page

Syntax

reporter = getReporter(result)

Description

reporter = getReporter(result) returns a reporter that you can use to include information about requirement links in a requirement link set. You can use this reporter to customize what information to include and how to format the information. See systemcomposer.rptgen.report.RequirementLink for more information on how to customize the reporter.

Input Arguments

expand all

Requirement link result, specified as a systemcomposer.rptgen.finder.RequirementLinkResult object.

Output Arguments

expand all

Requirement link reporter, returned as a systemcomposer.rptgen.report.RequirementLink object.

Examples

expand all

This example uses:

Open Live Script

Use the RequirementSetFinder, RequirementSetResult, RequirementLinkFinder, and RequirementLinkResult classes to create a report that finds all requirements in a given requirement set and link set.

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

Open the scKeylessEntrySystem project.

prj = openProject("scKeylessEntrySystem");
model_name = "KeylessEntryArchitecture";
mdl = systemcomposer.loadModel(model_name);

Create a report and append a title page and table of contents.

reqReport = slreportgen.report.Report(output="RequirementAnalysisReport", ...
    CompileModelBeforeReporting=false);
append(reqReport,TitlePage(Title="Requirement Sets and Link Sets in " + model_name));
append(reqReport,TableOfContents);

Create a chapter called Requirement Analysis.

reqChapter = Chapter("Requirement Analysis");

Create a section for requirement sets and use the finder, result, and reporter classes to find all requirements in the FunctionalRequirements.slreqx requirement set. Append the Requirement Sets section to the Requirement Analysis chapter.

reqSetSection = Section("Requirement Sets");
reqSetFinder = RequirementSetFinder("FunctionalRequirements.slreqx");
reqSetResult = find(reqSetFinder);
reqSetReporter = reqSetResult.getReporter;

append(reqSetSection,reqSetReporter);
append(reqChapter,reqSetSection);

Create a section for requirement links and use the finder, result, and reporter classes to find all requirement links in the KeylessEntryArchitecture.slmx requirement links set. Append the Requirement Links section to the Requirement Analysis chapter.

reqLinkSection = Section("Requirement Links");
reqLinkFinder = RequirementLinkFinder("KeylessEntryArchitecture");
reqLinkResult = find(reqLinkFinder);
reqLinkReporter = systemcomposer.rptgen.report.RequirementLink(Source=reqLinkResult);

append(reqLinkSection,reqLinkReporter);
append(reqChapter,reqLinkSection);

Append the Requirement Analysis chapter to the RequirementAnalysisReport and view the report.

append(reqReport,reqChapter);
close(reqReport);
rptview(reqReport);

Version History

Introduced in R2022b

See Also

Tools

Classes

Topics