slreq.ReqSet class

Package: slreq
Superclasses:

Work with Requirements sets

Description

Instances of slreq.ReqSet are Requirement Set objects.

Construction

newReqSet = slreq.new(reqSetName) creates a requirement set named reqSetName in the current working folder.

newReqSet = slreq.new(reqSetPath) creates a requirement set on the specified path.

Input Arguments

expand all

Name of the requirement set, specified as a character vector.

Example: 'Design Requirements'

The file name and path of the requirement set, specified as a character vector.

Example: 'C:\MATLAB\myReqSet.slreqx'

Output Arguments

expand all

An instance of the slreq.ReqSet object.

Properties

expand all

Name of the requirements set, specified as a character vector.

The file path of the requirements set, specified as a character vector.

Requirements set revision number, specified as a scalar.

The name of the individual or organization who created the requirements set.

The date the requirements set was created, specified as a datetime value. The software automatically populates this property.

The name of the individual or organization who last modified the requirements set.

The date the requirements set was last modified, specified as a datetime value. The software automatically populates this property.

Requirements set description text, specified as a character vector.

Indicates if the requirements set has unsaved changes. 0 for no unsaved changes, and 1 for unsaved changes.

Requirements set custom attribute names, specified as a cell array of character vectors.

Methods

addJustification Add justifications to requirement set
closeClose a requirements set
createReferencesCreate read-only references to requirement items in third-party documents
findFind requirements in requirements set that have matching attribute values
getImplementationStatus Query requirement set implementation status summary
getVerificationStatus Query requirement set verification status summary
importFromDocumentImport editable requirements from external documents
save Save a requirements set
updateImplementationStatusUpdate requirement set implementation status summary
updateVerificationStatusUpdate requirement set verification status summary

Examples

Create and Instantiate a Requirements Set Object

% Create a new requirements set
rs = slreq.new('My_Requirements_Set');

% Save and close the requirements set - saving creates a .slreqx file
save(rs);
close(rs);

% Load an existing requirements set
rs1 = slreq.load('Design_Specifications');

% Open the requirements set in the Requirements Editor
slreq.open(rs1);

Introduced in R2018a