slreq.createLink

R2026b

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 specifies the name of a Simulink^® model or the path to a Simulink block or subsystem, Stateflow^® chart, or System Composer™ port or component

• Handle to a Simulink block, 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

• slreq.TextRange object (since R2022b)

• RequirementRow object (since R2026a)

• String scalar or character vector that specifies the path to a MAT file (since R2024b)

Additionally, you can specify these Simulink Fault Analyzer™ objects:

• Fault (Simulink Fault Analyzer) (since R2023b)

• Conditional (Simulink Fault Analyzer) (since R2023b)

• SpreadsheetCell (Simulink Fault Analyzer) (since R2023b)

• SpreadsheetRow (Simulink Fault Analyzer) (since R2024b)

• Event (Simulink Fault Analyzer) (since R2026b)

• Gate (Simulink Fault Analyzer) (since R2026b)

• FailureModel (Simulink Fault Analyzer) (since R2026b)

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) (since R2023b), SpreadsheetRow (Simulink Fault Analyzer) (since R2024b), Event (Simulink Fault Analyzer), Gate (Simulink Fault Analyzer), or FailureModel (Simulink Fault Analyzer) object (since R2026b)

• slreq.TextRange object (since R2022b)

• RequirementRow object (since R2026a)

• String scalar or character vector that specifies the path to a MAT file (since R2024b)

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.

Tips

• To programmatically create links to requirements in third-party applications, use slreq.createExternalLink.

Version History

Introduced in R2018a

R2026a: Create links by using Requirements Table block rows

Link to and from requirements created from Requirements Table block rows by specifying a RequirementRow object in the src or dest arguments. For more information, see Manage Requirement Rows as slreq.Requirement Objects.

R2024b: Create links to and from MAT files

Link to and from MAT files by specifying the path to a MAT file as a string scalar or character vector in the src or dest arguments.