| Simulink® Verification and Validation™ | |
rmi setup
rmi register linktypename
rmi unregister linktypename
rmi linktypelist
reqlinks = rmi('createempty')
reqlinks = rmi('get', object)
reqlinks = rmi('get', object, group)
rmi('set', object, reqlinks)
rmi('set', object, reqlinks, group)
rmi('cat', object, reqlinks)
cnt = rmi('count', object)
rmi('clearall', object)
cmdstr = rmi('navcmd', object)
[cmdstr, titlestr] = rmi('navcmd', object)
guidstr = rmi('guidget', object)
object = rmi('guidlookup', model, guidstr)
rmi('highlightModel', object)
rmi('unhighlightModel', object)
rmi('view', object, index)
dialog = rmi('edit', object)
rmi('copyObj', object)
Use the rmi command to interact programmatically with the Requirements Management Interface (RMI).
rmi setup configures the RMI for use with your computer and installs the interface for use with the Telelogic DOORS software, if needed. See Configuring the Requirements Management Interface for more information about using this command to set up the RMI.
rmi register linktypename registers the custom link type specified by the M-file function linktypename. See Linking to Custom Types of Requirements Documents for more information.
rmi unregister linktypename removes the custom link type specified by the M-file function linktypename.
rmi linktypelist displays a list of the currently registered link types. The list indicates whether each link type is built-in or custom and provides the path to the M-file function used for its registration.
reqlinks = rmi('createempty') creates an empty instance of the requirement links data structure. See Requirement Links Data Structure for more information.
reqlinks = rmi('get', object) returns the requirement links data structure for object. object is the name or handle of a Simulink or Stateflow object with which requirements can be associated.
reqlinks = rmi('get', object, group) returns the requirement links data structure for the Signal Builder group specified by the index group. In this case, object is the name or handle of a Signal Builder block whose signal groups are associated with requirements.
rmi('set', object, reqlinks) sets the requirement links data structure reqlinks to object.
rmi('set', object, reqlinks, group) sets the requirement links data structure reqlinks to the Signal Builder group specified by the index group. In this case, object is the name or handle of a Signal Builder block whose signal groups you want to associate with requirements.
rmi('cat', object, reqlinks) appends the requirement links data structure reqlinks to the end of the existing structure associated with object. If no structure exists, the RMI sets reqlinks to object.
cnt = rmi('count', object) returns the number of requirement links associated with object.
rmi('clearall', object) removes the requirement links data structure associated with object, deleting its requirements.
cmdstr = rmi('navcmd', object) returns the MATLAB command string used to navigate to object. object is the name or handle of a Simulink or Stateflow object with which requirements can be associated. See Navigating to Simulink Models from External Documents for more information.
[cmdstr, titlestr] = rmi('navcmd', object) returns the MATLAB command string cmdstr and the title string titlestr that provides descriptive text for object.
guidstr = rmi('guidget', object) returns the globally unique identifier for object. A globally unique identifier is created for object if it lacks one. See Providing Unique Object Identifiers for more information.
object = rmi('guidlookup', model, guidstr) returns the object name in model that has the globally unique identifier specified by guidstr.
rmi('highlightModel', object) highlights all of the objects in the parent model of object that have requirement links.
rmi('unhighlightModel', object) removes highlighting of objects in the parent model of object that have requirement links.
rmi('view', object, index) accesses the requirement numbered index in the requirements document associated with object. index is an integer that represents the nth requirement linked to object.
dialog = rmi('edit', object) displays the Requirements dialog box for object and returns the handle of the dialog box.
rmi('copyObj', object) resets the globally unique identifier for object, preserving its requirement links.
Requirement links are represented using a MATLAB structure array with the following fields:
doc — a string identifying the requirements document, equivalent to the Document field of the Requirements dialog box.
id — a string defining a particular location in the requirements document. The first character in the string specifies the type of identifier that follows. Valid characters that can appear at the beginning of the string are
| Character | Identifier | Example |
|---|---|---|
? | Search text, the first occurrence of which is located in the requirements document | '?Requirement 1' |
@ | Named item, such as a bookmark in a Microsoft Word document or an anchor in an HTML document | '@my_req' |
# | Page or item number | '#21' |
> | Line number | '>3156' |
$ | Worksheet range in a spreadsheet | '$A2:C5' |
linked — a Boolean value specifying whether the requirement link is accessible for report generation and highlighting. The default value is 1 (true), specifying that the RMI can highlight the model object and include its requirement link in generated reports.
description — a string describing the requirement, equivalent to the Description field of the Requirements dialog box.
keywords — an optional string supplementing description, equivalent to the User tag field of the Requirements dialog box.
reqsys — a string identifying the link type registration name. This field displays 'other' for built-in link types.
| ModelAdvisor.Text | rminav | |
| © 1984-2008- The MathWorks, Inc. - Site Help - Patents - Trademarks - Privacy Policy - Preventing Piracy - RSS |