slreq.export

Export requirements as ReqIF files

Since R2023a

Syntax

dir = slreq.export(reqSetFile)

dir = slreq.export(rs)

dir = slreq.export(req)

dir = slreq.export(___,options)

Description

dir = slreq.export(reqSetFile) exports the requirement set file, reqSetFile, as a ReqIF™ file. By default, the function names the ReqIF file as export_, followed by the name of the requirement set file.

dir = slreq.export(rs) exports the requirement set object, reqSet.

dir = slreq.export(req) exports the requirement, req.

dir = slreq.export(___,options) exports the requirements using the options, options.

Examples

Export Requirement Set File as ReqIF File

Suppose you have a requirement set in the current folder, myReqs.slreqx. Export the requirement set as a ReqIF file.

slreq.export("myReqs.slreqx")

ans =

    'C:\MATLAB\My_Files\export_myReqs.reqif'

Export Requirement Set Object as ReqIF File

Suppose you have a requirement set in the current folder, myReqs.slreqx. Load the requirement set with the slreq.load function.

rs = slreq.load("myReqs.slreqx");

Export the requirement set.

slreq.export(rs)

ans =

    'C:\MATLAB\My_Files\export_myReqs.reqif'

Export Requirement as ReqIF File

Suppose you have a requirement set in the current folder, myReqs.slreqx and you want to export the requirement with the index 1. Load the requirement set with the slreq.load function.

rs = slreq.load("myReqs.slreqx");

Retrieve the requirement by using the find method.

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

Export the requirement.

slreq.export(req)

ans =

    'C:\MATLAB\My_Files\export_myReqs.reqif'

Export a Requirement with Options

Suppose you have a requirement set in the current folder, myReqs.slreqx, and you want to export the requirement set with a custom name. Load the requirement set with the slreq.load function.

rs = slreq.load("myReqs.slreqx");

Specify the custom name you want by defining a ExportOptions object.

opts = slreq.export.ExportOptions(outputFile="custom_name.reqif");

Export the requirement set by using the slreq.export function.

slreq.export(rs,opts)

ans =

    'custom_name.reqif'

Input Arguments

reqSetFile — Requirement set file

string scalar | character vector

Requirement set file, specified as a string scalar or character vector. If the file is not in the current directory, specify the path and the file name. The .slreqx extension is optional.

Data Types: char | string

rs — Requirement set

slreq.ReqSet object

Requirement set, specified as an slreq.ReqSet object.

req — Requirement

slreq.Requirement object

Requirement, specified as an slreq.Requirement object.

options — Export options

ExportOptions object

Export options, specified as a ExportOptions object. If you do not specify this argument, the function exports the requirements with the default settings of the object.

Output Arguments

dir — File name of exported requirement set

character vector

File name of the exported requirement set ReqIF file, returned as a character vector. The output argument includes the absolute path of the requirement set unless you specify the options argument.

Version History

Introduced in R2023a