Jump to content

LabVIEW VI Analyzer Toolkit: Difference between revisions

From LabVIEW Wiki
m Tests: Fix order of items
History: Add LabVIEW VI Analyzer Toolkit 2025 Q1
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
'''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.
'''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.


<blockquote>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.
<blockquote>The LabVIEW VI Analyzer Toolkit helps you perform static code analysis to improve the quality and readability of your LabVIEW code.
The LabVIEW VI Analyzer Toolkit is a software add-on for LabVIEW that helps you improve graphical code developed in LabVIEW. 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 you can create your own using the test creation wizard. The LabVIEW VI Analyzer Toolkit provides debugging tools that help you avoid 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.</blockquote>


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.
==Tests==
LabVIEW VI Analyzer Toolkit includes a wide range of tests in various categories:


--LabVIEW VI Analyzer Toolkit Marketing</blockquote>
{{LabVIEW VI Analyzer Toolkit TreeOfTests|version=-1}}
Unless otherwise stated, these tests are available in LabVIEW VI Analyzer Toolkit 2009 and later.


==Tests==
==API==
LabVIEW VI Analyzer Toolkit includes a wide range of tests in various categories:
LabVIEW VI Analyzer Toolkit installs several functions to automate the discovery and execution of tests. These functions are available from the [[VI Analyzer (Palette)|VI Analyzer]] palette.
 
{{node list
|VIAn Add Item
|VIAn Destroy Task
|VIAn Easy Analyze
|VIAn Easy Report
|VIAn Exclude Tests from VI
|VIAn Get Analysis Status
|VIAn Get Items
|VIAn Get Tests
|VIAn Modify Test Config Value
|VIAn Modify Test Settings
|VIAn New Task
|VIAn Remove Item
|VIAn Run
|VIAn Save Configuration File
|VIAn Select Tests
}}


{{#tree: minExpandLevel=1 |
===Deprecated===
*Block Diagram
{{node list
**Performance
|VIAn Add Password
***[[Arrays and Strings in Loops]]
***[[Coercion Dots]]
***[[Enabled Debugging]]
***[[In Place Element Structure Usage]] (LabVIEW VI Analyzer Toolkit 2013 and later)
***[[Inlinable VIs]] (LabVIEW VI Analyzer Toolkit 2010 and later)
***[[Parallel For Loop Debugging]] (LabVIEW VI Analyzer Toolkit 2019 and later)
***[[Parallelizable Loops]] (LabVIEW VI Analyzer Toolkit 2010 and later)
***[[Prepend Scalar With Build Array]] (LabVIEW VI Analyzer Toolkit 2010 and later)
***[[Redundant Boolean Operations]] (LabVIEW VI Analyzer Toolkit 2010 and later)
***[[Value Property Usage]] (LabVIEW VI Analyzer Toolkit 2010 and later)
***[[Wait in While Loop]]
***[[Wired Terminals in Subdiagrams]]
**Style
***[[Array Constant Style]] (LabVIEW VI Analyzer Toolkit 2019 and later)
***[[Backwards Wires]]
***[[Case Structure Default Frame]] (LabVIEW VI Analyzer Toolkit 2019 and later)
***[[Code Simplification]] (LabVIEW VI Analyzer Toolkit 2013 and later)
***[[Control Terminal Label Visible]]
***[[Control Terminal Wiring]]
***[[Diagram Disable Structures]] (LabVIEW VI Analyzer Toolkit 2019 and later)
***[[Mixed Terminal Styles]] (LabVIEW VI Analyzer Toolkit 2012 and later)
***[[Node Density]] (LabVIEW VI Analyzer Toolkit 2009 .. 2017)
***[[Poor Names of Enum Items]] (LabVIEW VI Analyzer Toolkit 2019 and later)
***[[Sequence Structure Usage]]
***[[String Constant Style]]
***[[Tunnel Position]] (LabVIEW VI Analyzer Toolkit 2010 and later)
***[[Unused Code]]
***[[Wire Bends]]
***[[Wire Crossings]]
***[[Wires Under Objects]]
**Warnings
***[[Adding Array Size Elements]]
***[[Array Sum and Product Overflow]] (LabVIEW VI Analyzer Toolkit 2013 and later)
***[[Breakpoint Detection]]
***[[Bundling Duplicate Names]]
***[[Case Structure with String Range]] (LabVIEW VI Analyzer Toolkit 2019 and later)
***[[Error Cluster Wired]]
***[[Find Deprecated Items]] (LabVIEW VI Analyzer Toolkit 2020 and later)
***[[For Loop Error Handling]] (LabVIEW VI Analyzer Toolkit 2018 and later)
***[[For Loop Iteration Count]]
***[[For Loop Reference Handling]] (LabVIEW VI Analyzer Toolkit 2020 and later)
***[[Globals and Locals]]
***[[Hidden Objects in Structures]]
***[[Hidden Tunnels]]
***[[Indexer Datatype]]
***[[Pattern Label]]
***[[Reentrant VI Issues]]
***[[Type Casting References]] (LabVIEW VI Analyzer Toolkit 2010 and later)
***[[Typedef Cluster Constants]] (LabVIEW VI Analyzer Toolkit 2009 .. 2017)
***[[Unwired I32 Error]] (LabVIEW VI Analyzer Toolkit 2019 and later)
*Complexity Metrics
**[[Cyclomatic Complexity]]
**[[Depth of Nesting of Structures]]
**[[Fan In]]
**[[Fan Out]]
**[[Modularity Index]]
*Documentation
**Developer
***[[Approved Bookmark Tags]] (LabVIEW VI Analyzer Toolkit 2019 and later)
***[[Comment Usage]]
***[[Label Call Library Nodes]]
***[[Revision History]]
**User
***[[Spell Check]]
***[[VI Documentation]]
*Front Panel
**SubVI
***[[Array Default Values]]
***[[Cluster Sized to Fit]]
***[[Control Alignment]]
**User Interface
***[[Alignment Grid Setting]] (LabVIEW VI Analyzer Toolkit 2020 and later)
***[[Clipped Text]]
***[[Dialog Controls]]
***[[Duplicate Control Labels]]
***[[Empty List Items]]
***[[Font Usage]]
***[[Overlapping Controls]]
***[[Panel Size and Position]]
***[[Scalar Chart Updates]] (LabVIEW VI Analyzer Toolkit 2010 and later)
***[[Synchronous Display]] (LabVIEW VI Analyzer Toolkit 2010 and later)
***[[Transparent Labels]]
*General
**File Properties
***[[SubVI and TypeDef Locations]]
***[[VI Extension]]
***[[VI Name]]
***[[VI Saved Version]]
***[[VI Size]]
**Icon and Connector Pane
***[[Connected Pane Terminals]] (LabVIEW VI Analyzer Toolkit 2009 .. 2017)
***[[Connector Pane Alignment]]
***[[Connector Pane Pattern]]
***[[Default Icon]]
***[[Error Style]]
***[[Full Connector Pane]] (LabVIEW VI Analyzer Toolkit 2010 and later)
***[[Icon Size and Border]]
***[[Polymorphic Terminals]]
***[[Terminal Connection Type]]
***[[Terminal Positions]]
**VI Properties
***[[Auto Error Handling Enabled]] (LabVIEW VI Analyzer Toolkit 2018 and later)
***[[Broken VI]]
***[[Built Application Compatibility]]
***[[Control VI Type]] (LabVIEW VI Analyzer Toolkit 2018 and later)
***[[Driver Usage]]
***[[Platform Portability]]
***[[Removed Diagram]]
***[[Separate Compiled Code Setting]] (LabVIEW VI Analyzer Toolkit 2020 and later)
***[[Toolkit Usage]]
***[[VI Lock State]]
*VI Metrics
**[[Connector Inputs and Outputs]]
**[[Controls and Indicators]]
**[[Diagram Count]]
**[[Diagram Size]]
**[[Node Count]]
**[[Property Reads and Writes]]
**[[Shared Library Calls]]
**[[Structure Count]]
**[[Wire Sources]]
}}
}}
Unless otherwise stated, these tests are available in LabVIEW VI Analyzer Toolkit 2009 and later.


==History==
==History==
{{history|product=LabVIEW VI Analyzer Toolkit|2025 Q1|
*Requires [[LabVIEW 2025 Q1]] or later
}}
{{history|product=LabVIEW VI Analyzer Toolkit|2024 Q1|
{{history|product=LabVIEW VI Analyzer Toolkit|2024 Q1|
*Files moved to the version-independent [[LVAddons directory]] for [[LabVIEW 2024 Q1]] and later
*Files moved to the version-independent [[LVAddons]] directory for [[LabVIEW 2024 Q1]] and later
}}
}}


Line 182: Line 85:
*Removed [[Typedef Cluster Constants]]
*Removed [[Typedef Cluster Constants]]
*Removed [[Connected Pane Terminals]]
*Removed [[Connected Pane Terminals]]
*Removed [[VIAn Add Password]]
}}
}}



Latest revision as of 11:23, 25 January 2025

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 perform static code analysis to improve the quality and readability of your LabVIEW code. The LabVIEW VI Analyzer Toolkit is a software add-on for LabVIEW that helps you improve graphical code developed in LabVIEW. 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 you can create your own using the test creation wizard. The LabVIEW VI Analyzer Toolkit provides debugging tools that help you avoid 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.

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