slreq.TextRange

Line range

Since R2022b

Description

Use slreq.TextRange objects to describe lines of code in a MATLAB^® code or plain-text external code file.

Creation

There are several ways to create an slreq.TextRange object:

• Create a link to MATLAB or plain-text external code by using the Requirements Editor. See Link MATLAB Code to Requirements.

• Use slreq.createTextRange.

Properties

Artifact — Name of file containing lines of code

character vector

This property is read-only.

Name of the file containing the lines of code, returned as a character vector.

Id — Line range identifier

character vector

This property is read-only.

Line range identifier, returned as a character vector. Requirements Toolbox™ generates this property value automatically for each slreq.TextRange object. If you create more than one slreq.TextRange object from the same file, each object has a unique Id property value.

Domain — Domain of artifact

character vector

This property is read-only.

Domain of the artifact that contains the linkable object, returned as a character vector.

Parent — MATLAB Function block SID

character vector

This property is read-only.

MATLAB Function block SID, returned as a character vector.

This property is empty for line ranges in MATLAB code files or other plain-text external code files, such as C files.

Object Functions

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

Examples

Create Line Ranges and Link to Requirement

This example shows how to create an slreq.TextRange object and link it to a requirement.

Create an slreq.TextRange object that corresponds to line numbers 1 and 2 in the myAdd function.

lineRange = slreq.createTextRange("myAdd.m",[1 2]);

View the slreq.TextRange object in the MATLAB® Editor.

show(lineRange);

Load the myAddRequirements requirement set.

rs = slreq.load("myAddRequirements");

Get a handle to the requirement with the summary Add u and v.

req = find(rs,Summary="Add u and v");

Create a link from the slreq.TextRange object to the requirement.

myLink = slreq.createLink(lineRange,req);

Version History

Introduced in R2022b