Author Requirements

Author natural language requirements in MATLAB^® and Simulink^®

Author requirements in MATLAB or Simulink by using the Requirements Editor, Requirements Perspective, or the programmatic interface. Capture details about the requirements as text, images, and tables by using requirement properties. Specify requirement types by using the built-in types, custom types, or stereotypes. Create requirement hierarchies that define relationships between child and parent requirements.

Apps

Requirements Editor	Create and edit requirements
Requirements Manager	Manage requirements and links in model
Profile Editor	Create and manage profiles with stereotypes and properties

Functions

expand all

Create Requirements

`slreq.new`	Create requirement set
`slreq.editor`	Open Requirements Editor
`slreq.convertAnnotation`	Convert annotations to requirement objects

Load and Clear Requirements

`slreq.load`	Load requirement set, link set, or Requirements Table block
`slreq.open`	Open requirement set
`slreq.clear`	Clear requirements and links from memory

Get Requirements

`slreq.find`	Find requirement, reference, and link set artifacts
`slreq.getCurrentObject`	Get selected objects in Requirements Editor, Requirements Browser, or Requirements Table block (Since R2021a)

Classes

`slreq.ReqSet`	Work with requirement sets
`slreq.Requirement`	Work with requirement objects

Methods

expand all

Requirement Set Methods

Get Requirements in Requirement Set

`find`	Find requirements in requirement set that have matching attribute values
`children`	Get top-level items in requirement set

Add Requirements and Justifications

`add`	Add requirements to requirement set
`addJustification`	Add justifications to requirement set

Customize Requirement Sets

`profiles`	Get profiles assigned to requirement sets
`saveProfileMapping`	Save profile mapping to XML file
`importProfile`	Assign profile to requirement set
`removeProfile`	Remove profile from requirement set
`inspectAttribute`	Get information about requirement set custom attribute
`updateAttribute`	Update information for requirement set custom attribute
`deleteAttribute`	Delete custom attribute from requirement set

Automate Load and Save Tasks

`getPostLoadFcn`	Get contents of `PostLoadFcn` callback
`getPreSaveFcn`	Get contents of `PreSaveFcn` callback
`setPostLoadFcn`	Assign `PostLoadFcn` callback script
`setPreSaveFcn`	Assign `PreSaveFcn` callback script

Save and Close Requirement Sets

`save`	Save requirement sets
`close`	Close requirement sets
`discard`	Close requirement set without saving

Requirement Methods

Add and Remove Requirements

`add`	Add child requirement
`copy`	Copy and paste requirement
`remove`	Remove requirement from requirement set

Get Requirements and Requirement Sets

`find`	Find children of parent requirements
`children`	Find child requirements of a requirement
`parent`	Find parent item of requirement
`reqSet`	Return parent requirement set

Move, Promote, and Demote Requirements

`move`	Move requirement in hierarchy
`moveDown`	Move requirement down in hierarchy
`moveUp`	Move requirement up in hierarchy
`demote`	Demote requirements
`promote`	Promote requirements

Add Comments and Customize Requirements

`addComment`	Add comments to requirements
`getAttribute`	Get requirement property values
`setAttribute`	Set requirement property values

Objects

slreq.View View settings (Since R2022b)

Topics

Define Requirements

Author Requirements in MATLAB or Simulink
Create requirements and define the requirement hierarchy with MATLAB or Simulink.
Define Requirements Hierarchy
Define the parent-child hierarchy for the requirements you associate with the design.
Requirement Types
Learn about the built-in and custom requirement types.
Use Command-Line API to Document Simulink Model in Requirements Editor

Programmatically author and link requirements to document your Simulink model design and create traceability.
- STEP 1: Capture Model as Requirements and Create Links
- STEP 2: Import Requirements and Reuse Existing Links
- STEP 3: Programmatically Repair Broken Links

Customize Requirements and Requirements Editor

Define Custom Requirement and Link Types and Properties
Customize requirements and links by using stereotypes or custom types and custom attributes.
Customize Requirement Index Numbering
Customize or disable the index of an individual requirement.
Configure Views in the Requirements Editor
Configure the Requirements Editor columns and create filters based on requirement and link metadata.

Featured Examples

Use Command-Line API to Document Simulink Model in Requirements Editor

Programmatically author and link requirements to document your Simulink model design and create traceability.

Open Live Script

Create Requirement Set Hierarchies by Using the Requirements Toolbox API

Programmatically create requirement set hierarchies by using the Requirements Toolbox™ API.

Open Live Script