slreq.Requirement Class

Namespace: slreq

Work with requirement objects

Description

Instances of slreq.Requirement are Requirement objects that you manage solely inside Requirements Toolbox™ and that do not have a persistent association with artifacts managed by external applications. Requirement objects can exist only within a requirement set.

Creation

req = find(rs, 'PropertyName', PropertyValue) finds and returns a requirement req in the requirement set rs with additional requirement properties specified by PropertyName and PropertyValue.

req = add(rs, 'PropertyName', PropertyValue) adds a requirement req to the requirement set rs with additional requirement properties specified by PropertyName and PropertyValue.

Input Arguments

rs — Requirement set object

slreq.ReqSet object

Requirement set, specified as an slreq.ReqSet object.

Output Arguments

req — Requirement object

slreq.Requirement object

Handle to a requirement, returned as an slreq.Requirement object.

Properties

Type — Requirement type

"Functional" | "Informational" | "Container" | string scalar | character vector

Requirement type, specified as "Functional", "Informational", "Container", or a string scalar or character vector that specifies a custom requirement type or stereotype. For more information, see Requirement Types.

Attributes:

GetAccess	public
SetAccess	public

Id — Requirement custom ID

string scalar | character vector

Custom ID of the requirement, specified as a string scalar or character vector. You cannot use spaces and '#' in custom IDs.

Attributes:

GetAccess	public
SetAccess	public

Summary — Requirement summary

string scalar | character vector

Requirement summary text, specified as a string scalar or character vector.

Attributes:

GetAccess	public
SetAccess	public

Description — Requirement description

string scalar | character vector

Requirement description text, specified as a string scalar or character vector.

Attributes:

GetAccess	public
SetAccess	public

Keywords — Requirement keywords

string array | cell array

Requirement keywords, specified as a string array or cell array of character vectors.

Attributes:

GetAccess	public
SetAccess	public

Rationale — Requirement rationale

string scalar | character vector

Requirement rationale text, specified as a string scalar or character vector.

Attributes:

GetAccess	public
SetAccess	public

CreatedOn — Date requirement was created

datetime value

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

Attributes:

GetAccess	public
SetAccess	private

CreatedBy — Requirement creator

character vector

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

Attributes:

GetAccess	public
SetAccess	private

ModifiedBy — Requirement modifier

character vector

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

Attributes:

GetAccess	public
SetAccess	private

IndexEnabled — Index enabled indicator

1 (default) | 0

Indicates whether the index is enabled (1) or disabled (0), returned as a 1 or 0 of data type logical. If you disable the index, Requirements Toolbox does not count this requirement when it creates the numbered hierarchy list. However, the requirement remains in the same place in the hierarchy.

Attributes:

GetAccess	public
SetAccess	public

IndexNumber — User-specified index value

empty double array (default) | int32 array

User-specified index value, returned as an empty double array or an int32 array. If empty, Requirements Toolbox calculates the Index value. Otherwise, Requirements Toolbox sets the Index property to the specified integer value.

Attributes:

GetAccess	public
SetAccess	public

SID — Requirement Session Independent Identifier

character vector

The Session Independent Identifier corresponding to the requirement, specified as a character vector.

Attributes:

GetAccess	public
SetAccess	private

FileRevision — Requirement revision number

scalar

Requirement revision number, returned as a scalar. When you create a new requirement, the FileRevision property matches the requirement set revision number. When you modify the requirement and save the requirement set, the requirement set revision number increments by one and the FileRevision property updates to match the new requirement set revision number. The FileRevision property updates only when you save changes to the requirement.

Attributes:

GetAccess	public
SetAccess	private

ModifiedOn — Date requirement was modified

datetime value

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

Attributes:

GetAccess	public
SetAccess	private

Dirty — Unsaved changes indicator

0 | 1

Indicates if the requirement has unsaved changes (1) or does not have unsaved changes (0).

Attributes:

GetAccess	public
SetAccess	private

Comments — Requirement comments

structure array

The comments that are attached with the requirement, specified as a structure.

Attributes:

GetAccess	public
SetAccess	private

Index — Requirement index

character array

The index of the requirement, specified as a character array.

Attributes:

GetAccess	public
SetAccess	private

Methods

add	Add child requirement
addComment	Add comments to requirements
children	Find child requirements of a requirement
copy	Copy and paste requirement
demote	Demote requirements
find	Find children of parent requirements
getAttribute	Get requirement property values
getDescriptionAsText	Get requirement description as plain text
getImplementationStatus	Query requirement implementation status summary
getRationaleAsText	Get requirement rationale as plain text
getVerificationStatus	Query requirement verification status summary
inLinks	Get incoming links for requirements
isFilteredIn	Check filtered requirements
isJustifiedFor	Check if requirement is justified
justifyImplementation	Justify requirements for implementation
justifyVerification	Justify requirements for verification
move	Move requirement in hierarchy
moveDown	Move requirement down in hierarchy
moveUp	Move requirement up in hierarchy
outLinks	Get outgoing links for requirements
parent	Find parent item of requirement
promote	Promote requirements
remove	Remove requirement from requirement set
reqSet	Return parent requirement set
setAttribute	Set requirement property values

Examples

Find a Requirement in a Requirement Set

This example shows how to find a requirement in a requirement set.

Load a requirement set called myReqSet.

rs = slreq.load("myReqSet");

Find a requirement with ID 77 in the requirement set.

req = find(rs,"Type","Requirement","ID","77");

req = 

  Requirement with properties:

             Id: '77'
        Summary: 'Test Spec'
       Keywords: [0×0 char]
    Description: ''
      Rationale: ''
            SID: 80
      CreatedBy: 'John Doe'
      CreatedOn: 05-Oct-2007 16:09:38
     ModifiedBy: 'Jane Doe'
     ModifiedOn: 21-Dec-2016 11:10:05
       Comments: [0×0 struct]

Version History

Introduced in R2018a