Q: Adding Category

2021-03-11T13:59:21Z

Adding Category

← Older revision		Revision as of 13:59, 11 March 2021
Line 286:		Line 286:
	[[Category:Conditional Disable Structure]]		[[Category:Conditional Disable Structure]]
	[[Category:Structures Palette]]		[[Category:Structures Palette]]
			[[Category:Debugging]]

Q at 17:46, 25 June 2020

2020-06-25T17:46:55Z

← Older revision		Revision as of 17:46, 25 June 2020
Line 1:		Line 1:
			{{TOCright}}
			{{LabVIEW Palette Object Information\|palette=Functions Palette/Programming/Structures{{!}}Structures palette\|type=vi\|icon=Functions Palette - Programming - Structures - Conditional Disable Structure.png}}

	[[File:Conditional Disable Structure - Components.png\|thumb\|Components of a Diagram Disable structure]]		[[File:Conditional Disable Structure - Components.png\|thumb\|Components of a Diagram Disable structure]]

	The ''Conditional Disable Structure'' is a primitive [[Functions Palette/Programming/Structures\|structure]] that can have one or more [[Subdiagram\|subdiagrams]] (also known as "Cases"), one of which is executed at runtime. The subdiagram to execute is determined based on conditions in the [[LabVIEW Project\|project]] that are evaluated at compile-time.		The '''Conditional Disable Structure''' is a primitive [[Functions Palette/Programming/Structures\|structure]] that can have one or more [[Subdiagram\|subdiagrams]] (also known as "Cases"), one of which is executed at runtime. The subdiagram to execute is determined based on conditions in the [[LabVIEW Project\|project]] that are evaluated at compile-time.

	<br clear="all">		<br clear="all">

Q: Q moved page Functions Palette/Programming/Structures/Conditional Disable Structure to Conditional Disable structure: Renaming to make it more in line with other palette items.

2020-06-23T18:32:45Z

Q moved page Functions Palette/Programming/Structures/Conditional Disable Structure to Conditional Disable structure: Renaming to make it more in line with other palette items.

← Older revision	Revision as of 18:32, 23 June 2020
(No difference)

Logmanoriginal: Add to Structures Palette

2020-05-15T13:24:48Z

Add to Structures Palette

← Older revision		Revision as of 13:24, 15 May 2020
Line 282:		Line 282:

	[[Category:Conditional Disable Structure]]		[[Category:Conditional Disable Structure]]
	[[Category:Structures]]		[[Category:Structures Palette]]

Q at 03:52, 2 September 2019

2019-09-02T03:52:47Z

← Older revision		Revision as of 03:52, 2 September 2019
Line 278:		Line 278:
	\| The ''Conditional Disable'' structure was added.		\| The ''Conditional Disable'' structure was added.
	\|}		\|}
			==See Also==
			*[[DisableStructure class]]

	[[Category:Conditional Disable Structure]]		[[Category:Conditional Disable Structure]]
	[[Category:Structures]]		[[Category:Structures]]

Logmanoriginal: Add new page

2019-08-12T20:09:56Z

Add new page

New page

[[File:Conditional Disable Structure - Components.png|thumb|Components of a Diagram Disable structure]]

The ''Conditional Disable Structure'' is a primitive [[Functions Palette/Programming/Structures|structure]] that can have one or more [[Subdiagram|subdiagrams]] (also known as "Cases"), one of which is executed at runtime. The subdiagram to execute is determined based on conditions in the [[LabVIEW Project|project]] that are evaluated at compile-time.

<br clear="all">
== Symbols ==

Symbols are unique identifiers that have case-sensitive values of alpha-numeric characters and underscores (<tt>[A-Za-z0-9_]+</tt>). Symbols are defined in multiple ways:

{| class="wikitable"
! Environment
| LabVIEW always provides the environment symbols [[#RUN_TIME_ENGINE|<tt>RUN_TIME_ENGINE</tt>]], [[#TARGET_TYPE|<tt>TARGET_TYPE</tt>]] and [[#TARGET_BITNESS|<tt>TARGET_BITNESS</tt>]] by default.
|-
! Project
| If a VI is located inside a project, the additional symbols [[#CPU|<tt>CPU</tt>]] and [[#OS|<tt>OS</tt>]] are available by default.
|-
! FPGA
| If the [[FPGA]] module is installed, the additional symbols [[#FPGA_EXECUTION_MODE|<tt>FPGA_EXECUTION_MODE</tt>]], [[#FPGA_TARGET_FAMILY|<tt>FPGA_TARGET_FAMILY</tt>]] and [[#FPGA_TARGET_CLASS|<tt>FPGA_TARGET_CLASS</tt>]] are made available.
|-
! Custom (project)
| Additional symbols can be added via the project properties.
|}

Environment and project symbols are managed by LabVIEW and cannot be changed. Custom symbols can be added manually.

=== Environment symbols ===

These symbols are defined by LabVIEW and cannot be changed.

==== RUN_TIME_ENGINE ====

Determines if the subdiagram is executed in the Run-Time Engine.

{| class="wikitable"
! Value
! Description
|-
| <tt>True</tt>
| Executes in the Run-Time Engine.
|-
| <tt>False</tt>
| Executes in the Development Environment.
|}

==== TARGET_TYPE ====

Determines on which platforms or targets the subdiagram executes.

{| class="wikitable"
! Value
! Description
|-
| <tt>Windows</tt>
| Executes on a [[Windows]] target.
|-
| <tt>FPGA</tt>
| Executes on an [[FPGA]] target.
|-
| <tt>IPBuilder</tt>
| Executes on [[IPBuilder]] FPGA targets.
|-
| <tt>Embedded</tt>
| Executes on an [[Embedded]] target.
|-
| <tt>RT</tt>
| Executes on an [[RT|Real-Time]] target.
|-
| <tt>Mac</tt>
| Executes on a [[Mac]] target.
|-
| <tt>Unix</tt>
| Executes on a [[Unix]] target.
|-
| <tt>PocketPC</tt>
| Executes on a [[PocketPC]] target.
|-
| <tt>DSP</tt>
| Executes on a [[DSP]] target.
|}

==== TARGET_BITNESS ====

Determines the bitness of the platform to execute the subdiagram.

{| class="wikitable"
! Value
! Description
|-
| <tt>32</tt>
| Executes on a 32-bit platform.
|-
| <tt>64</tt>
| Executes on a 64-bit platform.
|}

=== Project symbols ===

These symbols are only available for VIs inside projects.

==== CPU ====

Determines the CPU on which the subdiagram executes.

{| class="wikitable"
! Value
! Description
|-
| <tt>PowerPC</tt>
| Executes on [[Wikipedia:PowerPC|PowerPC]] CPUs.
|-
| <tt>x86</tt>
| Executes on [[Wikipedia:x86|x86]] CPUs.
|-
| <tt>ARM</tt>
| Executes on [[Wikipedia:ARM architecture|ARM]] CPUs.
|-
| <tt>null</tt>
| {{ambox|text=Unknown}}
|}

==== OS ====

Determines the type of [[OS|Operating System]].

{| class="wikitable"
! Value
! Description
|-
| <tt>Linux</tt>
| Executes on [[Wikipedia:Linux|Linux]].
|-
| <tt>Mac</tt>
| Executes on [[Wikipedia:MacOS|Mac]].
|-
| <tt>PharLap</tt>
| Executes on [[PharLap]].
|-
| <tt>VxWorks</tt>
| Executs on [[Wikipedia:VxWorks|VxWorks]].
|-
| <tt>Win</tt>
| Executes on [[Wikipedia:Microsoft Windows|Windows]].
|-
| <tt>null</tt>
|
|}

=== FPGA symbols ===

These symbols are defined by the LabVIEW FPGA module and cannot be changed. Symbols are available if the VI is placed under an FPGA target in the project.

==== FPGA_EXECUTION_MODE ====

Determines the execution mode of the subdiagram within an FPGA VI.

{| class="wikitable"
! Value
! Description
|-
| <tt>FPGA_TARGET</tt>
| Executes on an FPGA target.
|-
| <tt>DEV_COMPUTER_SIM_IO</tt>
| Executes in a Simulated I/O simulation environment.
|-
| <tt>DEV_COMPUTER_REAL_IO</tt>
| Executes in a Real I/O simulation environment.
|-
| <tt>THIRD_PARTY_SIMULATION</tt>
| Executes in a Third-Party simulation environment.
|}

==== FPGA_TARGET_FAMILY ====

Determines the FPGA family.

{| class="wikitable"
! Value
! Description
|-
| <tt>VIRTEX2</tt>
| Executes on the [[Wikipedia:Virtex (FPGA)#Virtex-II|VIRTEX2]] family.
|-
| <tt>VIRTEX5</tt>
| Executes on the [[Wikipedia:Virtex (FPGA)#Virtex-5|VIRTEX5]] family.
|-
| <tt>VIRTEX6</tt>
| Executes on the [[Wikipedia:Virtex (FPGA)#Virtex-6|VIRTEX6]] family.
|-
| <tt>SPARTAN3</tt>
| Executes on the [[Wikipedia:Xilinx#Spartan family|SPARTAN3]] family.
|-
| <tt>SPARTAN6</tt>
| Executes on the [[Wikipedia:Xilinx#Spartan family|SPARTAN6]] family.
|-
| <tt>ZYNQ</tt>
| Executes on the [[Wikipedia:Xilinx#Zynq|ZYNQ]] family.
|-
| <tt>KINTEX7</tt>
| Executes on the [[Wikipedia:Xilinx#Kintex|KINTEX7]] family.
|}

==== FPGA_TARGET_CLASS ====

Determines the FPGA class. Available values depend on the connected FPGA target and can be accessed from the ''FPGA Target Properties'' dialog box.

== Conditions ==

The ''Diagram Disable'' structure supports two conditions:

{| class="wikitable"
! <tt>==</tt>
| The value of the symbol must be '''equal''' to the specified value.
|-
! <tt>!=</tt>
| The value of the symbol must be '''different''' (not equal) to the specified value.
|}

Each subdiagram can have one or more conditions.

=== Configure conditions ===

[[File:Conditional Disable Structure - Configure Condition.png|thumb|Configure Condition dialog]]

Conditions are defined in the ''Configure Condition'' dialog box. This dialog box appears for any of the following right-click menu options.

{| class="wikitable"
! Add Subdiagram After...
| Adds a subdiagram '''after''' the current diagram.
|-
! Add Subdiagram Before...
| Adds a subdiagram '''before''' the current diagram.
|-
! Duplicate Subdiagram
| Duplicates the current subdiagram.
|-
! Edit Condition For This Subdiagram...
| Opens the ''Configure Condition'' dialog box for the current subdiagram.
|}

All available symbols are listed in the drop-down list under ''Symbol(s)''. A new symbol can be defined by manually writing the symbol name in the drop-down list. However, the symbol will not appear in the project automatically. The next drop-down list after ''Symbol(s)'' defines the condition for the value.

The buttons "<tt>+</tt>" and "<tt>-</tt>" add or remove additional conditions. If more than one condition is defined, a new drop-down list appears on the left which defines how the results of conditions are evaluated. Available options are: ''<tt>AND</tt>'' and ''<tt>OR</tt>''.

The checkbox "''Make Default?''" makes the current subdiagram the default diagram if none of the conditions for any subdiagram was met.

<br clear="all">
== Custom conditional disable symbols ==

[[File:Conditional Disable Structure - Conditional Disable Symbols.png|thumb|Conditional Disable symbols in the project properties dialog.]]

Conditional disable symbols can be defined in the project properties on the ''Conditional Disable Symbols'' page. To define a new symbol, insert the symbol name and it's initial value and press "Add". The selected symbol can be removed with the "Remove Selected Items" button.

The value of a symbol can be changed by clicking in the "''Values''" field in the list and writing the new value.

<br clear="all">
== Best practice ==

* Use the [[Functions Palette/Programming/Structures/Diagram Disable Structure|Diagram Disable]] structure to permanently or temporarily disable sections of code.
* Use the upper case naming convention for symbol names.
* Use the upper case naming convention for symbol values.

== History ==

{{ambox|text=Which version added the ''RUN_TIME_ENGINE'' symbol?}}
{{ambox|text=When and how are the ''FPGA_*'' symbols added?}}
{{ambox|text=Which version added the ''IPBuilder'' and ''DSP'' values for the ''TARGET_TYPE'' symbol?}}
{{ambox|text=Can anyone confirm that the value ''Linux'' for ''TARGET_TYPE'' was renamed to ''Unix'' between LV8.6 and LV2009?}}

{| class="wikitable"
! Version
! Change(s)
|-
| [[File:LV8-2013.png|frameless|border|64x64px|LabVIEW 8.5|link=LabVIEW 8.5]]
| Objects in the inactive subdiagrams are no longer loaded into memory.
|-
| [[File:LV8-2013.png|frameless|border|64x64px|LabVIEW 8|link=LabVIEW 8]]
| The ''Conditional Disable'' structure was added.
|}

[[Category:Conditional Disable Structure]]
[[Category:Structures]]

Conditional Disable structure - Revision history

Q: Adding Category

Q at 17:46, 25 June 2020

Q: Q moved page Functions Palette/Programming/Structures/Conditional Disable Structure to Conditional Disable structure: Renaming to make it more in line with other palette items.

Logmanoriginal: Add to Structures Palette

Q at 03:52, 2 September 2019

Logmanoriginal: Add new page