Link Type Properties

Link type properties define how links are created, identified, navigated to, and stored within the requirement management tool. The following table describes each of these properties.

PropertyDescription
Registration

The name of the function that creates the link type. The RMI stores this name in the Simulink® model.

Label

A string to identify this link type. In the Requirements Traceability Link Editor, this string appears on the Document type drop-down list for a Simulink or Stateflow® object.

IsFile

A Boolean property that indicates if the linked documents are files within the computer file system. If a document is a file:

  • The software uses the standard method for resolving the path.

  • In the Requirements Traceability Link Editor, when you click Browse, the file selection dialog box opens.

Extensions

An array of file extensions. Use these file extensions as filter options in the Requirements Traceability Link Editor when you click Browse. The file extensions infer the link type based on the document name. If you registered more than one link type for the same file extension, the link type that you registered takes first priority.

LocDelimiters

A string containing the list of supported navigation delimiters. The first character in the ID of a requirement specifies the type of identifier. For example, an identifier can refer to a specific page number (#4), a named bookmark (@my_tag), or some searchable text (?search_text). The valid location delimiters determine the possible entries in the Requirements Traceability Link Editor Location drop-down list.

NavigateFcn

The MATLAB® callback invoked when you click a link. The function has two input arguments: the document field and the ID field of the link:

feval(LinkType.NavigateFcn, Link.document, Link.id)
ContentsFcn

The MATLAB callback invoked when you click the Document Index tab in the Requirements Traceability Link Editor. This function has a single input argument that contains the full path of the resolved function or, if the link type is not a file, the Document field contents.

The function returns three outputs:

  • Labels

  • Depths

  • Locations

BrowseFcn

The MATLAB callback invoked when you click Browse in the Requirements Traceability Link Editor. You do not need this function when the link type is a file. The function takes no input arguments and returns a single output argument that identifies the selected document.

CreateURLFcn

The MATLAB callback that constructs a path name to the requirement. This function uses the document path or URL to create a specific requirement URL. The requirement URL is based on a location identifier specified in the third input argument. The input arguments are:

  • Full path name to the requirements document

  • Info about creating a URL to the document (if applicable)

  • Location of the requirement in the document

This function returns a single output argument, the string to use when navigating to the requirement from the generated report.

IsValidDocFcn

The MATLAB callback invoked when you run a requirements consistency check. The function takes one input argument—the fully qualified name for the requirements document. It returns true if the document can be located; it returns false if the document cannot be found or the document name is invalid.

IsValidIdFcn

The MATLAB callback invoked when you run a requirements consistency check. This function takes two input arguments:

  • Fully qualified name for the requirements document

  • Location of the requirement in the document

IsValidIdFcn returns true if it finds the requirement and false if it cannot find that requirement in the specified document.

IsValidDescFcn

The MATLAB callback invoked when you run a requirements consistency check. This function has three input arguments:

  • Full path to the requirements document

  • Location of the requirement in the document

  • Requirement description label as stored in Simulink

IsValidDescFcn returns two outputs:

  • True if the description matches the requirement, false otherwise.

  • The requirement label in the document, if not matched in Simulink.

DetailsFcn

The MATLAB callback invoked when you generate the requirements report with the Include details from linked documents option. This function returns detailed content associated with the requirement and has three input arguments:

  • Full path to the requirements document

  • Location of the requirement in the document

  • Level of details to include in report (Unused)

The DetailsFcn returns two outputs:

  • Numeric array that describes the hierarchical relationship among the fragments in the cell array

  • Cell array of formatted fragments (paragraphs, tables, et al.) from the requirement

SelectionLinkFcn

The MATLAB callback invoked when you use the selection-based linking menu option for this document type. This function has two input arguments:

  • Handle to the model object that will have the requirement link

  • True if a navigation object is inserted into the requirements document, or false if no navigation object is inserted

SelectionLinkFcn returns the requirements link structure for the selected requirement.

Was this topic helpful?