slreq.LinkSet Class

Namespace: slreq

Work with link sets

Description

Instances of slreq.LinkSet are Link Set objects. Links are organized in link sets. Each link set is associated with a source artifact such as a Simulink^® model or a data dictionary and is serialized into a separate file which stores the links associated with it. The default location and name of the link set file matches that of the source artifact.

Creation

allLinkSets = slreq.find('Type', 'LinkSet') finds and returns an array of loaded slreq.LinkSet objects allLinkSets.

myLinkSet = slreq.find('Type', 'LinkSet', 'Name', ArtifactName) finds and returns an slreq.LinkSet object myLinkSet matching the artifact name specified by ArtifactName.

myLinkSet = slreq.load(ArtifactName) loads an slreq.LinkSet object myLinkSet matching the artifact name specified by ArtifactName.

Input Arguments

ArtifactName — Link set artifact name

character vector

The name of the link set artifact, specified as a character vector.

Output Arguments

allLinkSets — Link sets

slreq.LinkSet array

Array of loaded link sets.

myLinkSet — Link set

slreq.LinkSet object

Link set, returned as an slreq.LinkSet object.

Properties

Filename — Link set file path

character vector

File path of the link set, specified as a character vector. By default, the link set is stored in the same folder as the artifact and has the same base file name and an .slmx extension.

Artifact — Artifact containing link sources

character vector

Artifact that contains the link sources for the link set, specified as a character vector. When you create a link, the link set is associated with the artifact that the link source item belongs to. By default, the link set is stored in the same folder as the artifact and has the same base file name and an .slmx extension. For more information, see Link Storage. The artifact can be any file that contains a linkable item, such as a Simulink model or a Simulink Test™ file.

Domain — Link set domain

character vector

The domain of the links in the link set.

Example: linktype_rmi_excel, linktype_rmi_doors

Revision — Link set revision number

scalar

Link set revision number, returned as a scalar. The revision number increments when you save changes.

Dirty — Unsaved changes indicator

0 | 1

Indicates if the link set has unsaved changes. 0 for no unsaved changes and 1 for unsaved changes.

Description — Link set description

character vector

Link set description text, specified as a character vector.

CustomAttributeNames — Custom attributes associated with the link set

cell array of character vectors

Link set custom attribute names, specified as a cell array of character vectors.

Methods

addAttribute	Add custom attribute to link set
clearChangeIssues	Clear link set change issues
createTextRange	Create line ranges
deleteAttribute	Delete custom attribute from link set
deleteOrphanLinks	Delete links with invalid source
exportToVersion	Export link set to previous MATLAB version
find	Find links in link set with matching attribute values
getBrokenLinks	Get links with invalid destination
getLinks	Get links from link set
getLinksWithChangedDestination	Get links with destination item changes
getLinksWithChangedSource	Get links with source item changes
getOrphanLinks	Get links with invalid source
getRegisteredReqSets	Get requirement sets registered in link set
getTextRange	Get line ranges
getTextRanges	Get lines ranges that span multiple lines
importProfile	Assign profile to ink set
inspectAttribute	Get information about link set custom attribute
profiles	Get profiles assigned to link set
redirectLinksToImportedReqs	Redirect link destination from external document to imported requirement set
removeProfile	Remove profile from link set
save	Save link set
sources	Get link sources
updateAttribute	Update information for link set custom attribute
updateBacklinks	Synchronize external navigation links
updateDocUri	Update link destinations for renamed or moved document
updateRegisteredReqSets	Update requirement sets registered to link set

Examples

Find, Load, and Edit a Link Set

This example shows how to find, load, and edit a link set.

Find a loaded link set by using the name.

myLinkSet1 = slreq.find("Type","LinkSet","Name","Project_req")

myLinkSet1 = 

  LinkSet with properties:

    Description: ''
       Filename: 'Project_req.slmx'
       Artifact: 'Project_req.slreqx'
         Domain: 'linktype_rmi_slreq'
       Revision: 2
          Dirty: 0

Load a link set associated with a Simulink model called fuelsys.

myLinkSet2 = slreq.load("fuelsys.slx")

myLinkSet2 = 

  LinkSet with properties:

    Description: ''
       Filename: 'C:\MATLAB\My_Files\fuelsys_linkset.slmx'
       Artifact: 'D:\Work\Design_Specs\fuelsys.slx'
         Domain: 'linktype_rmi_simulink'
       Revision: 2
          Dirty: 0 

Set the link set description.

myLinkSet2.Description = "Link set for the fuel system"

myLinkSet2 = 

  LinkSet with properties:

    Description: 'Link set for the fuel system'
       Filename: 'C:\MATLAB\My_Files\fuelsys_linkset.slmx'
       Artifact: 'D:\Work\Design_Specs\fuelsys.slx'
         Domain: 'linktype_rmi_simulink'
       Revision: 2
          Dirty: 1 

Version History

Introduced in R2018a