slreq.callback.CustomImportOptions class

Package: slreq.callback

Custom import options

Since R2022a

Description

Use objects of the slreq.callback.CustomImportOptions class to adjust the options to use when import requirements. When you import requirements from a custom third-party document, slreq.getCurrentImportOptions generates an slreq.callback.CustomImportOptions object that you can use to adjust the options to use during import. You can only access this object in the PreImportFcn callback.

The slreq.callback.CustomImportOptions class is a handle class.

Creation

options = slreq.getCurrentImportOptions returns an slreq.callback.CustomImportOptions object if you import requirements from a custom third-party document.

Properties

Rationale — External attribute mapped to Rationale

string scalar | character vector

External attribute mapped to the Rationale property, specified as a string scalar or character vector.

Example: myImportOptions.Rationale = "Requirement rationale";

Attributes:

GetAccess	public
SetAccess	public

Keywords — External attribute mapped to Keywords

string scalar | character vector

External attribute mapped to the Keywords property, specified as a string scalar or character vector.

Example: myImportOptions.Keywords = "Requirement keywords";

Attributes:

GetAccess	public
SetAccess	public

Attributes — External attributes to import

cell array

External attributes to import as custom attributes, specified as a cell array.

Example: myImportOptions.Attributes = {'Priority','Status'};

Attributes:

GetAccess	public
SetAccess	public

Filter — Filter condition to apply during import

string scalar | character vector

Filter condition to apply during import, specified as a string scalar or a character vector.

Example: myImportOptions.Filter = "AttributeName==Value";

Attributes:

GetAccess	public
SetAccess	public

AsReference — Option to import as references

1 (default) | 0

Option to import as slreq.Reference objects, specified as a 1 or 0 of data type logical. If 0, requirements import as slreq.Requirement objects.

Attributes:

GetAccess	public
SetAccess	public

RichText — Option to import with rich text

0 (default) | 1

Option to import requirements with rich text, specified as a 1 or 0 of data type logical.

Attributes:

GetAccess	public
SetAccess	public

DocUri — Resource identifier for requirements document

string scalar | character vector

Resource identifier for external requirements document, specified as a string scalar or character vector.

Attributes:

GetAccess	public
SetAccess	public

DocType — Requirements document custom link type

string scalar | character vector

Requirements document custom link type, returned as a string scalar or character vector.

Attributes:

GetAccess	public
SetAccess	private

ReqSet — Requirement set name

character vector

Requirement set name, returned as a character vector.

Attributes:

GetAccess	public
SetAccess	private

PreImportFcn — Contents of PreImportFcn callback

string scalar | character vector

Contents of the PreImportFcn callback for the current Import node, specified as a string scalar or a character vector.

Attributes:

GetAccess	public
SetAccess	public

PostImportFcn — Contents of PostImportFcn callback

string scalar | character vector

Contents of the PostImportFcn callback for the current Import node, specified as a string scalar or a character vector.

Attributes:

GetAccess	public
SetAccess	public

Version History

Introduced in R2022a