Main Content

slreq.Reference class

Package: slreq
Superclasses:

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 requirements set.

Construction

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

ref = add(rs, 'Artifact', FileName, 'PropertyName', PropertyValue) adds a referenced requirement ref to a requirements 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.

Referenced requirement custom ID, returned as a character vector.

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

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.

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

Example: 'linktype_rmi_doors', 'linktype_rmi_excel'

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.

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

Referenced requirement summary text, returned as a character vector.

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

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

Referenced requirement keywords, specified as a character array.

Referenced requirement type. For more information, see Requirement Types.

The Session Independent Identifier corresponding to the referenced requirement.

Referenced requirement revision number, specified as a scalar.

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

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

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

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

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

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

Methods

addAdd referenced requirements
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
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
parentFind parent item of referenced requirement
removeRemove referenced requirements
reqSetReturn parent requirements set
setAttributeSet referenced requirement custom attributes
unlock Unlock referenced requirements
unlockAll Unlock all child referenced requirements for editing
updateFromDocumentUpdate referenced requirements from external requirements document

Examples

Get the Handle to a Referenced Requirement

% Find a referenced requirement with Id R9 in a requirement set rs
ref = find(rs, 'Type', 'Reference', 'Id', 'R9')

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

Introduced in R2018a