Main Content

slreq.ReqSet class

Package: slreq

Work with requirement sets

Description

Instances of slreq.ReqSet are requirement set objects.

Creation

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 requirement set, specified as a character vector.

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

Requirement set revision number, specified as a scalar.

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

The date the requirement 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 requirement set.

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

Requirement set description text, specified as a character vector.

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

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

Methods

addAdd requirements to requirement set
addAttributeAdd custom attribute to requirement set
addJustification Add justifications to requirement set
childrenGet top-level items in requirement set
closeClose a requirement set
createReferencesCreate read-only references to requirement items in third-party documents
deleteAttributeDelete custom attribute from requirement set
discardClose requirement set without saving
exploreOpen requirement set in Requirements Editor
exportToVersionExport requirement set to previous MATLAB version
findFind requirements in requirement set that have matching attribute values
getImplementationStatus Query requirement set implementation status summary
getPostLoadFcnGet contents of PostLoadFcn callback
getPreSaveFcnGet contents of PreSaveFcn callback
getVerificationStatus Query requirement set verification status summary
importFromDocumentImport editable requirements from external documents
inspectAttributeGet information about requirement set custom attribute
runTests Run test cases linked to the requirement set
save Save a requirement set
setPostLoadFcnAssign PostLoadFcn callback script
setPreSaveFcnAssign PreSaveFcn callback script
updateAttributeUpdate information for requirement set custom attribute
updateImplementationStatusUpdate requirement set implementation status summary
updateReferencesUpdate referenced requirements in requirement set
updateSrcArtifactUriUpdate document resource identifier of imported requirements
updateSrcFileLocationUpdate document location of imported requirements
updateVerificationStatusUpdate requirement set verification status summary

Examples

collapse all

This example shows how to create, save, and open a requirement set object.

Create a new requirement set called Design_Requirements.

rs = slreq.new("Design_Requirements");

Save and close the requirement set.

save(rs);
close(rs);

Open the requirement set in the Requirements Editor.

slreq.open(rs);

Version History

Introduced in R2018a