systemcomposer.rptgen.finder.RequirementSetResult Class

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

Search result for requirements

Since R2022b

Description

Search result object for information about a requirement in a requirement set.

The systemcomposer.rptgen.finder.RequirementSetResult class is a handle class.

Creation

result = ComponentResult creates a search result object for a requirement that you find by using a systemcomposer.rptgen.finder.RequirementSetFinder object.

Note

The find method of the systemcomposer.rptgen.finder.RequirementSetFinder class creates a search result object for each requirement that it finds. You do not need to create this object yourself.

Properties

Object — Universal unique identifier of result element

string

Universal unique identifier (UUID) of result element, returned as a string.

Data Types: string

ID — ID of requirement

string

ID of requirement, returned as a string.

Data Types: string

Summary — Summary of requirement

string

Summary of requirement, returned as a string.

Data Types: string

Link — Requirement link

string

Requirement link, returned as a string.

Data Types: string

Tag — Tag to associate with result

string

Tag to associate with result, specified as a string. You can use this property to attach additional information to a result. You can set this property to any value that meets your requirements.

Data Types: string

Methods

Public Methods

getReporter

Get requirements reporter

Version History

Introduced in R2022b