Jump to content

LabVIEW VI Analyzer Toolkit: Difference between revisions

From LabVIEW Wiki
← Older editNewer edit →
Visual
m →Tests: Fix order of items
Add API section
Line 136: Line 136:
}}
}}
Unless otherwise stated, these tests are available in LabVIEW VI Analyzer Toolkit 2009 and later.
Unless otherwise stated, these tests are available in LabVIEW VI Analyzer Toolkit 2009 and later.
==API==
LabVIEW VI Analyzer Toolkit installs several functions to automate the discovery and execution of tests. These functions are available from the [[VI Analyzer palette]].
{| class="wikitable"
!Name
!Description
|-
|[[File:VIAn Add Item.png|frameless|32x32px|link=VIAn Add Item|VIAn Add Item]] [[VIAn Add Item]]
|Adds an item, such as a [[VI]], [[LLB]], or [[wikipedia:folder (computing)|folder]], to the VI Analyzer task.
|-
|[[File:VIAn Destroy Task.png|frameless|32x32px|link=VIAn Destroy Task|VIAn Destroy Task]] [[VIAn Destroy Task]]
|Closes an existing VI Analyzer task reference and releases resources associated with the task.
|-
|[[File:VIAn Easy Analyze.png|frameless|32x32px|link=VIAn Easy Analyze|VIAn Easy Analyze]] [[VIAn Easy Analyze]]
|Runs a VI Analyzer task automatically using settings in the specified configuration file.
|-
|[[File:VIAn Easy Report.png|frameless|32x32px|link=VIAn Easy Report|VIAn Easy Report]] [[VIAn Easy Report]]
|Exports the results of an analysis to a file, either as a report in [[wikipedia:ASCII|ASCII]] or [[wikipedia:HTML]] format or as a VI Analyzer results file.
|-
|[[File:VIAn Exclude Tests from VI.png|frameless|32x32px|link=VIAn Exclude Tests from VI|VIAn Exclude Tests from VI]] [[VIAn Exclude Tests from VI]]
|Specifies the tests to exclude for a specific VI in the VI Analyzer task.
|-
|[[File:VIAn Get Analysis Status.png|frameless|32x32px|link=VIAn Get Analysis Status|VIAn Get Analysis Status]] [[VIAn Get Analysis Status]]
|Monitors the progress of the analysis.
|-
|[[File:VIAn Get Items.png|frameless|32x32px|link=VIAn Get Items|VIAn Get Items]] [[VIAn Get Items]]
|Returns a list of all top-level VIs, folders, or LLBs in the VI Analyzer task.
|-
|[[File:VIAn Get Tests.png|frameless|32x32px|link=VIAn Get Tests|VIAn Get Tests]] [[VIAn Get Tests]]
|Returns a cluster array containing the configuration information for each test in the VI Analyzer task.
|-
|[[File:VIAn Modify Test Config Value.png|frameless|32x32px|link=VIAn Modify Test Config Value|VIAn Modify Test Config Value]] [[VIAn Modify Test Config Value]]
|Modifies the value of a single configuration option for a specific test.
|-
|[[File:VIAn Modify Test Settings.png|frameless|32x32px|link=VIAn Modify Test Settings|VIAn Modify Test Settings]] [[VIAn Modify Test Settings]]
|Modifies the configuration settings of a single test.
|-
|[[File:VIAn New Task.png|frameless|32x32px|link=VIAn New Task|VIAn New Task]] [[VIAn New Task]]
|Creates a VI Analyzer task, which you can use with other VI Analyzer VIs to configure and run an analysis.
|-
|[[File:VIAn Remove Item.png|frameless|32x32px|link=VIAn Remove Item|VIAn Remove Item]] [[VIAn Remove Item]]
|Removes an item, such as a VI, LLB, or folder, or excludes a subitem, such as a VI within an LLB or folder, from the VI Analyzer task.
|-
|[[File:VIAn Run.png|frameless|32x32px|link=VIAn Run|VIAn Run]] [[VIAn Run]]
|Analyzes VIs using the settings that ''VI Analyzer Task in'' specifies. You can wire the results to the [[VIAn Easy Report]] VI.
|-
|[[File:VIAn Save Configuration File.png|frameless|32x32px|link=VIAn Save Configuration File|VIAn Save Configuration File]] [[VIAn Save Configuration File]]
|Saves the current VI Analyzer task settings to a configuration file.
|-
|[[File:VIAn Select Tests.png|frameless|32x32px|link=VIAn Select Tests|VIAn Select Tests]] [[VIAn Select Tests]]
|Selects or deselects the specified tests in the VI Analyzer task.
|}


==History==
==History==

Revision as of 09:44, 11 August 2024

LabVIEW VI Analyzer Toolkit is a LabVIEW add-on that extends the features of VI Analyzer with common tests, APIs, Project Explorer integration, and a test creator utility.

The LabVIEW VI Analyzer Toolkit helps you improve the quality and readability of graphical code developed in LabVIEW software. With this toolkit, you can configure more than 90 included tests for automated code review and static code analysis of all VIs in an application, or create your own using the test creation wizard.

Use the LabVIEW VI Analyzer Toolkit to debug and avoid overlooking improper coding techniques that could impact an application’s performance, functionality, or maintainability. In addition, you can enforce effective programming practices and coding styles within teams of developers to ensure code readability and functionality. By using this toolkit regularly, you can develop high-quality, robust LabVIEW applications.

--LabVIEW VI Analyzer Toolkit Marketing

Tests

LabVIEW VI Analyzer Toolkit includes a wide range of tests in various categories:

  • Block Diagram
  • Complexity Metrics
  • Documentation
  • Front Panel
  • General
  • VI Metrics

Unless otherwise stated, these tests are available in LabVIEW VI Analyzer Toolkit 2009 and later.

API

LabVIEW VI Analyzer Toolkit installs several functions to automate the discovery and execution of tests. These functions are available from the VI Analyzer palette.

Name Description
VIAn Add Item VIAn Add Item Adds an item, such as a VI, LLB, or folder, to the VI Analyzer task.
VIAn Destroy Task VIAn Destroy Task Closes an existing VI Analyzer task reference and releases resources associated with the task.
VIAn Easy Analyze VIAn Easy Analyze Runs a VI Analyzer task automatically using settings in the specified configuration file.
VIAn Easy Report VIAn Easy Report Exports the results of an analysis to a file, either as a report in ASCII or wikipedia:HTML format or as a VI Analyzer results file.
VIAn Exclude Tests from VI VIAn Exclude Tests from VI Specifies the tests to exclude for a specific VI in the VI Analyzer task.
VIAn Get Analysis Status VIAn Get Analysis Status Monitors the progress of the analysis.
VIAn Get Items VIAn Get Items Returns a list of all top-level VIs, folders, or LLBs in the VI Analyzer task.
VIAn Get Tests VIAn Get Tests Returns a cluster array containing the configuration information for each test in the VI Analyzer task.
VIAn Modify Test Config Value VIAn Modify Test Config Value Modifies the value of a single configuration option for a specific test.
VIAn Modify Test Settings VIAn Modify Test Settings Modifies the configuration settings of a single test.
VIAn New Task VIAn New Task Creates a VI Analyzer task, which you can use with other VI Analyzer VIs to configure and run an analysis.
VIAn Remove Item VIAn Remove Item Removes an item, such as a VI, LLB, or folder, or excludes a subitem, such as a VI within an LLB or folder, from the VI Analyzer task.
VIAn Run VIAn Run Analyzes VIs using the settings that VI Analyzer Task in specifies. You can wire the results to the VIAn Easy Report VI.
VIAn Save Configuration File VIAn Save Configuration File Saves the current VI Analyzer task settings to a configuration file.
VIAn Select Tests VIAn Select Tests Selects or deselects the specified tests in the VI Analyzer task.

History

See also

External links

Retrieved from "https://labviewwiki.org/w/index.php?title=LabVIEW_VI_Analyzer_Toolkit&oldid=33170"