slreq.convertAnnotation

Convert annotations to requirement objects

Syntax

myReq = slreq.convertAnnotation(myAnnotation,myDestination)

myReq = slreq.convertAnnotation(myAnnotation,myDestination,Name,Value)

Description

myReq = slreq.convertAnnotation(myAnnotation,myDestination) converts a Simulink^® or a Stateflow^® annotation myAnnotation into a requirement myReq and stores it in a destination entity myDestination.

myReq = slreq.convertAnnotation(myAnnotation,myDestination,Name,Value) converts a Simulink or a Stateflow annotation myAnnotation into a requirement myReq and stores it in a destination entity myDestination using additional options specified by one or more Name, Value pair arguments.

Examples

Convert Simulink Annotation to Requirement

1. Find annotations in a Simulink model.

   allAnnotations = find_system("controller_Model",FindAll="on", ...
      Type="annotation");

2. Create a new requirement set.

   newReqSet = slreq.new("myNewReqSet");

3. Convert one annotation into a requirement newReq and add it to newReqSet.

   newReq = slreq.convertAnnotation(allAnnotations(1), ...
       newReqSet);

Input Arguments

myAnnotation — Simulink or Stateflow annotation

Simulink.Annotation object

The annotation to be converted, specified as a Simulink.Annotation object.

myDestination — Converted annotation destination entity

slreq.Requirement object | slreq.ReqSet object

The destination entity for the converted annotation, specified either as an slreq.Requirement or as an slreq.ReqSet object.

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Before R2021a, use commas to separate each name and value, and enclose Name in quotes.

Example: 'CreateLinks',true

CreateLinks — Option to create links

true (default) | false

Option to create links when converting annotations, specified as a Boolean value.

KeepAnnotation — Option to retain annotation

false (default) | true

Option to retain the annotation after conversion, specified as a Boolean value.

IgnoreCallback — Option to force annotation conversion

false (default) | true

Option to specify annotation conversion even if a callback function is specified in the annotation, specified as a Boolean value.

ShowMarkup — Option to display requirements markup

true (default) | false

Option to display the Requirement markup after annotation conversion, specified as a Boolean value.

Output Arguments

myReq — Requirement

slreq.Requirement object

The converted annotation, returned as an slreq.Requirement object.

Version History

Introduced in R2018a