LabVIEW Type

NI Requirements Gateway 2018 Help

Edition Date: March 2018

Part Number: 371714F-01

»View Product Info
Download Help (Windows Only)

The LabVIEW type browses a specified LabVIEW VI, project file, class file, project library, or LLB—or a directory that contains LabVIEW files—for VIs, controls and indicators of VIs, or labels of block diagram functions, nodes, and wires that contain the correct information for requirements or references. For example, the VIs in an LLB can cover the requirements for functions in an instrument driver, or the VIs in an application can cover requirements for the graphical user interface and its underlying logic.

Requirements Gateway launches a progress dialog box when analyzing LabVIEW files. The progress dialog box displays the Requirements Gateway project document and the LabVIEW file (.vi, .lvproj, .lvclass, .lvlib, .llb, .ctl, .vit, or .ctt) Requirements Gateway is currently analyzing. You cannot use LabVIEW or Requirements Gateway until analysis completes and the progress dialog box closes.

Tip Tip  Complete the LabVIEW tutorial to learn how to add to a project a downstream LabVIEW document that covers requirements in an upstream document.

Traceability Elements

The LabVIEW type captures the following traceability information from a LabVIEW source file.

  • Section—A directory, VI, LLB, statechart, project, target, LabVIEW library, or LabVIEW class.
  • Requirement[REQ: reqid] in the Documentation field of a VI, control, or indicator or the label of a VI. The requirement can appear anywhere in the text of the Documentation field or label.
  • Reference[Covers: reqid] in the following locations:
    • Documentation field of a VI, control, or indicator or the label of a VI
    • Documentation field or label of block diagram functions, nodes, wires when you enable the Analyze Diagrams variable for the LabVIEW document

    The reference can appear anywhere in the text of the Documentation field or label.
  • Attribute(#name), where name is the name of the attribute, in a description field of a VI, control, or indicator. The attribute must appear after the corresponding requirement.
  • Reference Attribute(*attribute name) in the following locations:
    • Documentation field of a VI, control, or indicator or the label of a VI
    • Documentation field or label of block diagram functions, nodes, or wires when you enable the Analyze Diagrams variable for the LabVIEW document

    The attribute must appear after the corresponding reference.
  • Link—A duplicate file.

Configuring a LabVIEW Document

Use multiple LabVIEW files in a single project document to cover requirements. Requirements Gateway considers upstream requirements covered if the combination of LabVIEW files in a single downstream LabVIEW document covers the requirements.

When you modify and save a VI or control in a LabVIEW project, Requirements Gateway prompts you to reanalyze the project.

The LabVIEW type defines the following document settings you configure for a LabVIEW document on the Details tab of the Project pane of the Configuration dialog box.

  • File or Directory—The LabVIEW file or directory that contains LabVIEW files. Click File Browse to launch the Select Files to Include in Document dialog box, in which you can select one or more VIs, projects, classes, project libraries, or LLBs. In the Select Files to Include in Document dialog box, you can also specify whether to include all the subVIs of a selected VI or LLB or to include subdirectories of a selected directory.
  • Variable—Defines the following document variables:
    • Category—Assigns an analysis category to the LabVIEW document. Select a category from the Value pull-down menu. Use the Overall Quality pane of the Management view to review the use of analysis categories in a project.
    • Analyze Diagrams—Specifies that Requirements Gateway analyzes the descriptions and labels of block diagram structures, functions, and wires. The variable is disabled by default. Enabling the Analyze Diagrams variable for a document increases the time required for Requirements Gateway to analyze the document. Use the Value column option to enable this variable.
    • With Images—Captures the front panel and diagram images of selected VIs. Use the Value column option to enable this variable.

Opening LabVIEW Files in the Context of a LabVIEW Project

When you double-click a VI or control contained in a LabVIEW project to navigate to the VI or control from Requirements Gateway, Requirements Gateway opens the VI or control and the Project Explorer window of the LabVIEW project so that you can review the project, including any settings in the project that affect the VI or control. The project name and the target name appear in the status bar of the front panel of the VI or control in LabVIEW.

Creating a LabVIEW Reference from Requirements Gateway

To add a reference in a LabVIEW file, insert the correct syntax for a LabVIEW reference in a description field of a VI, control, or indicator, or in the descriptions and labels of block diagram structures, functions, and wires. In Requirements Gateway, right-click an upstream requirement covered by a downstream LabVIEW document and select Copy For from the context menu to launch a submenu that contains the following options:

  • LabVIEW Description Reference—Copies [Covers: reqid] to the system clipboard. You can then paste the reference in the description of a VI, control, or indicator.
  • LabVIEW Text Reference—Copies [Covers: reqid] to the system clipboard. You can then paste the reference in the text of a VI, control, or indicator.
Note Note  The syntax for a LabVIEW Description Reference and a LabVIEW Text Reference are identical. The LabVIEW type formats the XML of the intermediate file in such a way that a LabVIEW control can have both text and a description, but displays the information differently. You can create a custom LabVIEW type that formats description and text references differently.

WAS THIS ARTICLE HELPFUL?

Not Helpful