slreq.createLink

Create traceable links

Syntax

myLink = slreq.createLink(src,dest)

Description

myLink = slreq.createLink(src,dest) creates a link between the source item specified by src and the destination item specified by dest.

Examples

Create Links

This example shows how to create a link.

Open the ShortestPath example.

openProject("ShortestPath");

Load the shortest_path_tests_reqs requirement set.

rs = slreq.load("shortest_path_tests_reqs");

Get a handle to the requirement with the index 2.1.3.

req = find(rs,Index="2.1.3");

Find the line range associated with line number four in the graph_unit_tests MATLAB® code file.

lr = slreq.getTextRange("graph_unit_tests.m",4);

Create a link between the requirement and the line of code in the MATLAB file.

myLink = slreq.createLink(req,lr);

Get a handle to the link set, then save it.

myLinkSet = linkSet(myLink);
tf = save(myLinkSet)

tf = logical
   1

Input Arguments

src — Link source item

string scalar | character vector | double | slreq.Requirement object | slreq.Reference object | ...

Link source item, specified as a:

• slreq.Requirement or slreq.Reference object

• String scalar or character vector that lists the name of a Simulink^® model or path to a Simulink block or subsystem, a Stateflow^® chart, or a System Composer™ port or component

• Handle to a Simulink block or subsystem or a System Composer port or component

• Stateflow.Chart (Stateflow), Stateflow.State (Stateflow), or Stateflow.Transition (Stateflow) object

• Simulink.data.dictionary.Entry (Simulink) object

• sltest.testmanager.TestFile (Simulink Test), sltest.testmanager.TestSuite (Simulink Test), sltest.testmanager.TestCase (Simulink Test), or sltest.testmanager.TestIteration (Simulink Test) object

• Fault (Simulink Fault Analyzer), Conditional (Simulink Fault Analyzer), SpreadsheetCell (Simulink Fault Analyzer), or SpreadsheetRow (Simulink Fault Analyzer) object

• slreq.TextRange object

dest — Link destination item

string scalar | character vector | double | slreq.Requirement object | slreq.Reference object | ...

Link destination item, specified as a:

• slreq.Requirement or slreq.Reference object

• String scalar or character vector that lists the name of a Simulink model or path to a Simulink block or subsystem, a Stateflow chart, or a System Composer port or component

• Handle to a Simulink block or subsystem or a System Composer port or component

• Stateflow.Chart (Stateflow), Stateflow.State (Stateflow), or Stateflow.Transition (Stateflow) object

• Simulink.data.dictionary.Entry (Simulink) object

• sltest.testmanager.TestFile (Simulink Test), sltest.testmanager.TestSuite (Simulink Test), sltest.testmanager.TestCase (Simulink Test), or sltest.testmanager.TestIteration (Simulink Test) object

• Fault (Simulink Fault Analyzer), Conditional (Simulink Fault Analyzer), SpreadsheetCell (Simulink Fault Analyzer), or SpreadsheetRow (Simulink Fault Analyzer) object

• slreq.TextRange object

Output Arguments

myLink — Link

slreq.Link object

Link, returned as an slreq.Link object.

Limitations

• MATLAB^® Online™ does not support linking to requirements in Microsoft^® Word, Microsoft Excel^®, or IBM^® DOORS^® documents.

Version History

Introduced in R2018a