Main Content

slreq.Reference class

Package: slreq

Work with external requirement proxy objects

Description

Instances of slreq.Reference are proxies for external requirement objects that a third-party external application manages and maintains. Referenced requirement objects are read-only but can be synchronized from an external application and can exist only within a requirement set.

Creation

ref = find(rs, 'Type', 'Reference', 'PropertyName', PropertyValue) finds and returns a referenced requirement or a set of referenced requirements ref in the requirement set rs specified by the properties matching PropertyName and PropertyValue.

ref = add(rs, 'Artifact', FileName, 'PropertyName', PropertyValue) adds a referenced requirement ref to a requirement set rs which references requirements from the external document specified by FileName with properties and custom attributes specified by PropertyName and PropertyValue.

Input Arguments

expand all

Requirement set, specified as an slreq.ReqSet object.

File name for a top-level container identifier, such as a Microsoft® Office document name or an IBM® Rational® DOORS® Module unique ID.

Output Arguments

expand all

Referenced requirement, specified as an slreq.Reference object.

Properties

expand all

Referenced requirement ID, returned as a character vector.

Attributes:

GetAccess
public
SetAccess
private

Referenced requirement custom ID, returned as a character vector.

Attributes:

GetAccess
public
SetAccess
private

Top-level container identifier, like a Microsoft Office document name or an IBM Rational DOORS Module unique ID.

Attributes:

GetAccess
public
SetAccess
private

Unique requirement identifier in the source requirements document. For requirements imported from IBM Rational DOORS, the ArtifactId is the Numeric Object Id. For requirements imported from Microsoft Word, the bookmark names are used as the ArtifactId.

Attributes:

GetAccess
public
SetAccess
private

The custom link type of the requirements document. For more information, see Custom Link Types.

Example: 'linktype_rmi_doors', 'linktype_rmi_excel'

Attributes:

GetAccess
public
SetAccess
private

The date and time the referenced requirement was last synchronized with the external document, specified as a datetime value. The software automatically populates this property.

Attributes:

GetAccess
public
SetAccess
private

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

Attributes:

GetAccess
public
SetAccess
private

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

Attributes:

GetAccess
public
SetAccess
private

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

Attributes:

GetAccess
public
SetAccess
private

Indicates if the referenced requirement is locked. 1 for locked and 0 for unlocked.

Attributes:

GetAccess
public
SetAccess
private

Referenced requirement summary text, returned as a character vector.

Attributes:

GetAccess
public
SetAccess
public

Referenced requirement description text, returned as a multiline character vector.

Attributes:

GetAccess
public
SetAccess
public

Referenced requirement rationale text, returned as a multiline character vector.

Attributes:

GetAccess
public
SetAccess
public

Referenced requirement keywords, specified as a character array.

Attributes:

GetAccess
public
SetAccess
public

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

Attributes:

GetAccess
public
SetAccess
public

Indicates if the referenced requirement index is enabled (1) or disabled (0), returned as a 1 or 0 of data type logical. Disabling the index omits the referenced requirement from the numbered hierarchy list.

Attributes:

GetAccess
public
SetAccess
public

User-specified referenced requirement 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

The Session Independent Identifier corresponding to the referenced requirement.

Attributes:

GetAccess
public
SetAccess
private

Referenced requirement revision number, specified as a scalar.

Attributes:

GetAccess
public
SetAccess
private

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

Attributes:

GetAccess
public
SetAccess
private

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

Attributes:

GetAccess
public
SetAccess
private

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

Attributes:

GetAccess
public
SetAccess
private

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

Attributes:

GetAccess
public
SetAccess
private

Methods

addAdd child referenced requirement
addComment Add comments to referenced requirements
childrenFind children references
findFind children of parent referenced requirements
getAttributeGet referenced requirement custom attributes
getImplementationStatus Query referenced requirement implementation status summary
getPostImportFcnGet contents of PostImportFcn callback
getPreImportFcnGet registered PreImportFcn callback script
getVerificationStatus Query referenced requirement verification status summary
isJustifiedForCheck if referenced requirement is justified
justifyImplementation Justify referenced requirements for implementation
justifyVerification Justify referenced requirements for verification
moveDownMove referenced requirement down in hierarchy
moveUpMove referenced requirement up in hierarchy
parentFind parent item of referenced requirement
removeRemove referenced requirements
reqSetReturn parent requirement set
setAttributeSet referenced requirement custom attributes
setParentSet parent of referenced requirement in PostImportFcn callback
setPostImportFcnAssign PostImportFcn callback script
setPreImportFcnAssign PreImportFcn callback script
unlock Unlock referenced requirements
unlockAll Unlock all child referenced requirements for editing
updateFromDocumentUpdate referenced requirements from external requirements document

Examples

collapse all

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

Load a requirement set called myReqSet.

rs = slreq.load("myReqSet");

Find a requirement with ID 9 in the requirement set.

req = find(rs,"Type","Reference","ID","9");
ref = 

  Reference with properties:

          Keywords: [0×0 char]
          Artifact: 'Req_doc.docx'
                Id: 'R9'
           Summary: 'System overview'
       Description: ''
               SID: 3
            Domain: 'linktype_rmi_word'
    SynchronizedOn: 25-Jul-2017 11:34:02

Version History

Introduced in R2018a