slreq.ReqSet Class

Namespace: 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

reqSetName — Requirement set name

character vector

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

Example: 'Design Requirements'

reqSetPath — Requirement set file name and path

character vector

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

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

Output Arguments

newReqSet — Requirement set

slreq.ReqSet object

An instance of the slreq.ReqSet object.

Properties

Name — Requirement set name

character vector

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

Filename — Requirement set file path

character vector

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

Revision — Requirement set revision number

scalar

Requirement set revision number, returned as a scalar. The revision number increments when you save changes.

CreatedBy — Requirement set creator

character vector

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

CreatedOn — Date requirement set was created

datetime value

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

ModifiedBy — Requirement set modifier

character vector

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

ModifiedOn — Date requirement set was modified

datetime value

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

Description — Requirement set description

character vector

Requirement set description text, specified as a character vector.

Dirty — Unsaved changes indicator

0 | 1

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

CustomAttributeNames — Custom attributes associated with the requirement set

cell array of character vectors

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

Methods

add	Add requirements to requirement set
addAttribute	Add custom attribute to requirement set
addJustification	Add justifications to requirement set
children	Get top-level items in requirement set
close	Close a requirement set
createReferences	Create read-only references to requirement items in third-party documents
deleteAttribute	Delete custom attribute from requirement set
discard	Close requirement set without saving
explore	Open requirement set in Requirements Editor
exportToVersion	Export requirement set to previous MATLAB version
find	Find requirements in requirement set that have matching attribute values
getImplementationStatus	Query requirement set implementation status summary
getPostLoadFcn	Get contents of PostLoadFcn callback
getPreSaveFcn	Get contents of PreSaveFcn callback
getVerificationStatus	Query requirement set verification status summary
importFromDocument	Import editable requirements from external documents
importProfile	Assign profile to requirement set
inspectAttribute	Get information about requirement set custom attribute
profiles	Get profiles assigned to requirement sets
removeProfile	Remove profile from requirement set
runTests	Run test cases linked to requirement set
save	Save a requirement set
saveProfileMapping	Save profile mapping to XML file
setPostLoadFcn	Assign PostLoadFcn callback script
setPreSaveFcn	Assign PreSaveFcn callback script
updateAttribute	Update information for requirement set custom attribute
updateImplementationStatus	Update requirement set implementation status summary
updateReferences	Update referenced requirements in requirement set
updateSrcArtifactUri	Update document resource identifier of imported requirements
updateSrcFileLocation	Update document location of imported requirements
updateVerificationStatus	Update requirement set verification status summary

Examples

Create, Save, and Open a Requirement Set Object

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