Track and Visualize Links

Measure requirements implementation and verification and identify changes

Track and visualize links by using implementation status, traceability matrices, and traceability diagrams. Trace requirements to generated code created from models and MATLAB^® code.

Apps

Requirements Editor	Create and edit requirements
Requirements Manager	Manage requirements and links in model
Profile Editor	Create and manage profiles with stereotypes and properties

Functions

expand all

Get Traceability Information

`slreq.find`	Find requirement, reference, and link set artifacts
`slreq.inLinks`	Get incoming links for requirement or other linkable item
`slreq.outLinks`	Get outgoing links for a block or other linkable item
`slreq.getDependentLinkSets`	Retrieve link sets with incoming links to requirement set (Since R2023a)
`slreq.getExternalURL`	Get navigation URL for link source or destination, requirement, test or Simulink model element (Since R2021a)
`slreq.getIncomingLinkTypeLabel`	Retrieve incoming link type label (Since R2023a)
`slreq.getOutgoingLinkTypeLabel`	Retrieve outgoing link type label (Since R2023a)
`slreq.getTextRange`	Get line ranges (Since R2022b)
`slreq.structToObj`	Convert link source or destination information from structure to model object type
`slreq.refreshLinkDependencies`	Refresh requirement link dependencies

Track and Visualize Traceability

`slreq.generateTraceabilityDiagram`	Create a traceability diagram (Since R2021b)
`slreq.generateTraceabilityMatrix`	Create traceability matrix (Since R2021a)
`slreq.getTraceabilityMatrixOptions`	Create options structure for traceability matrix (Since R2021a)
`slreq.show`	Navigate to link source or destination (Since R2020a)

Load and Manage Link Files

`slreq.load`	Load requirement set, link set, or Requirements Table block
`slreq.clear`	Clear requirements and links from memory
`slreq.map`	Get or set path to link set file

Classes

expand all

Link Classes

`slreq.LinkSet`	Work with link sets
`slreq.Link`	Traceable link

Requirement Classes

`slreq.ReqSet`	Work with requirement sets
`slreq.Reference`	Work with external requirement proxy objects
`slreq.Justification`	Requirement justifications

Methods

expand all

Link Set Methods

`getRegisteredReqSets`	Get requirement sets registered in link set
`updateRegisteredReqSets`	Update requirement sets registered to link set
`sources`	Get link sources
`save`	Save link set

Link Methods

`destination`	Get link destination
`source`	Get link source
`getDestinationOpenCommand`	Retrieve command that opens link destination
`getSourceOpenCommand`	Retrieve command that opens link source
`getDestinationURL`	Retrieve URL that opens link destination
`getSourceURL`	Retrieve URL that opens link source
`remove`	Delete links

Requirement Set Methods

`getImplementationStatus`	Query requirement set implementation status summary
`updateImplementationStatus`	Update requirement set implementation status summary

Requirement Methods

`inLinks`	Get incoming links for requirements
`outLinks`	Get outgoing links for requirements
`getImplementationStatus`	Query requirement implementation status summary
`isJustifiedFor`	Check if requirement is justified
`justifyImplementation`	Justify requirements for implementation

Referenced Requirement Methods

`inLinks`	Get incoming links for referenced requirements
`outLinks`	Get outgoing links for referenced requirements
`getImplementationStatus`	Query referenced requirement implementation status summary
`isJustifiedFor`	Check if referenced requirement is justified
`justifyImplementation`	Justify referenced requirements for implementation

Justification Methods

outLinks Get outgoing links for justifications

Objects

`slreq.TextRange`	Line range (Since R2022b)
`slreq.matrix.Configuration`	Traceability matrix configuration (Since R2024a)
`slreq.matrix.Filter`	Filter for traceability matrix (Since R2024a)

Object Functions

expand all

Modify Line Ranges

`deleteLinks`	Delete links for line ranges
`getLineRange`	Get line numbers for line range
`getLinks`	Get links for line range
`getText`	Get contents of line range
`remove`	Delete unused line ranges
`setLineRange`	Set line numbers for line range
`show`	Open and highlight line range in MATLAB Editor

Configure Traceability Matrices

`addFilterToCell`	Add cell filter to traceability matrix configuration
`addFilterToHighlight`	Add highlighting to traceability matrix configuration
`addFilterToLeft`	Add filter to left artifacts in traceability matrix configuration
`addFilterToMatrix`	Add matrix settings filter to traceability matrix configuration
`addFilterToTop`	Add filter to top artifacts in traceability matrix configuration
`exportToScript`	Export traceability matrix configuration to script

Topics

Track Requirement Links

Track Requirement Links by Using Implementation Status
Use the requirements implementation status to check how extensively requirements are implemented in your model.
Track Requirement Links with a Traceability Matrix
Track and manage links and change issues by using traceability matrices.
Configure Views in the Requirements Editor
Configure the Requirements Editor columns and create filters based on requirement and link metadata.
Navigate to Requirements from Simulink Model
Navigate from a Simulink^® model element to linked requirements.

Track Changes to Requirements and Linked Items

Track Changes to Requirement Links
Track and resolve changes to requirement links, and provide comments for other reviewers.
Track Changes to Test Cases in Requirements Editor
Track changes to test cases linked to requirements by using the Requirements Editor.

Visualize Links

Visualize Links with Traceability Diagrams
Visualize the traceability structure of requirements and other Model-Based Design items by using traceability diagrams.
Assess Allocation and Impact
Assess the allocation of requirements and the impact of changes.
Highlight Model Objects with Requirements
Highlight a model to see which objects in the model have links to requirements in external documents.
View Requirements Details for a Selected Block
View requirement details in the Simulink canvas.

Trace Requirements to Generated Code

Requirements Traceability for Code Generated from MATLAB Code
Include comments in generated code that contain information about requirement links to MATLAB code.
Trace Requirements to Code Generated from Models
Configure your model to include information about requirement links in the generated code.

Related Information

Featured Examples

Make Requirements Fully Traceable with a Traceability Matrix

Identify requirements within a project that are unlinked and link them to Model-based Design items.

Open Live Script