Jump to content

LabVIEW VI Analyzer Toolkit: Difference between revisions

From LabVIEW Wiki
Add VIAn Add Password and history info
Line 140: Line 140:
LabVIEW VI Analyzer Toolkit installs several functions to automate the discovery and execution of tests. These functions are available from the [[VI Analyzer palette]].
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"
{{node list
!Name
|VIAn Add Item
!Description
|VIAn Destroy Task
|-
|VIAn Easy Analyze
|[[File:VIAn Add Item.png|frameless|32x32px|link=VIAn Add Item|VIAn Add Item]] [[VIAn Add Item]]
|VIAn Easy Report
|Adds an item, such as a [[VI]], [[LLB]], or [[wikipedia:folder (computing)|folder]], to the VI Analyzer task.
|VIAn Exclude Tests from VI
|-
|VIAn Get Analysis Status
|[[File:VIAn Add Password.png|frameless|32x32px|link=VIAn Add Password|VIAn Add Password]] [[VIAn Add Password]]
|VIAn Get Items
|Adds a password to the VI Analyzer task password cache. Use this VI if you want to analyze password-protected VIs and the LabVIEW password cache does not contain the passwords. (LabVIEW VI Analyzer Toolkit 2009 .. 2017)
|VIAn Get Tests
|-
|VIAn Modify Test Config Value
|[[File:VIAn Destroy Task.png|frameless|32x32px|link=VIAn Destroy Task|VIAn Destroy Task]] [[VIAn Destroy Task]]
|VIAn Modify Test Settings
|Closes an existing VI Analyzer task reference and releases resources associated with the task.
|VIAn New Task
|-
|VIAn Remove Item
|[[File:VIAn Easy Analyze.png|frameless|32x32px|link=VIAn Easy Analyze|VIAn Easy Analyze]] [[VIAn Easy Analyze]]
|VIAn Run
|Runs a VI Analyzer task automatically using settings in the specified configuration file.
|VIAn Save Configuration File
|-
|VIAn Select Tests
|[[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.
 
|-
===Deprecated===
|[[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]]
{{node list
|Specifies the tests to exclude for a specific VI in the VI Analyzer task.
|VIAn Add Password
|-
}}
|[[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.
|}
Unless otherwise stated, these functions are available in LabVIEW VI Analyzer Toolkit 2009 and later.


==History==
==History==

Revision as of 07:32, 12 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:

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.

Icon Name
VIAn Add ItemVIAn Add Item
VIAn Destroy TaskVIAn Destroy Task
VIAn Easy AnalyzeVIAn Easy Analyze
VIAn Easy ReportVIAn Easy Report
VIAn Exclude Tests from VIVIAn Exclude Tests from VI
VIAn Get Analysis StatusVIAn Get Analysis Status
VIAn Get ItemsVIAn Get Items
VIAn Get TestsVIAn Get Tests
VIAn Modify Test Config ValueVIAn Modify Test Config Value
VIAn Modify Test SettingsVIAn Modify Test Settings
VIAn New TaskVIAn New Task
VIAn Remove ItemVIAn Remove Item
VIAn RunVIAn Run
VIAn Save Configuration FileVIAn Save Configuration File
VIAn Select TestsVIAn Select Tests

Deprecated

Icon Name
VIAn Add PasswordVIAn Add Password

History

See also

External links