Diagram Disable structure - Revision history

Q at 15:53, 25 June 2020

2020-06-25T15:53:41Z

← Older revision		Revision as of 15:53, 25 June 2020
Line 1:		Line 1:
	{{TOCright}}		{{TOCright}}
	{{LabVIEW Palette Object Information\|palette=Functions Palette/Programming/Structures{{!}}Structures palette\|type=structure}}		{{LabVIEW Palette Object Information\|palette=Functions Palette/Programming/Structures{{!}}Structures palette\|type=structure\|icon=Functions Palette - Programming - Structures - Diagram Disable Structure.png}}
	[[File:Diagram Disable Structure - Components.png\|thumb\|Components of a Diagram Disable structure]]		[[File:Diagram Disable Structure - Components.png\|thumb\|Components of a Diagram Disable structure]]

Q: Added info table

2020-06-23T20:41:53Z

Added info table

← Older revision		Revision as of 20:41, 23 June 2020
Line 1:		Line 1:
	{{~~Cleanup~~}}		{{TOCright}}
			{{LabVIEW Palette Object Information\|palette=Functions Palette/Programming/Structures{{!}}Structures palette\|type=structure}}
	[[File:Diagram Disable Structure - Components.png\|thumb\|Components of a Diagram Disable structure]]		[[File:Diagram Disable Structure - Components.png\|thumb\|Components of a Diagram Disable structure]]

	A ''Diagram 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 programmer must manually specify the subdiagram to execute. Disabled subdiagrams do not break a VI if they contain broken wires or SubVIs.		A '''Diagram 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 programmer must manually specify the subdiagram to execute. Disabled subdiagrams do not break a VI if they contain broken wires or SubVIs.

	~~<br clear~~=~~"all">~~		== Usage ==
	== Code execution ==		=== Code execution ===
	[[File:Diagram Disable Structure - Case selector with two disabled cases.png\|thumb\|Diagram Disable structure with two disabled cases]]		[[File:Diagram Disable Structure - Case selector with two disabled cases.png\|thumb\|Diagram Disable structure with two disabled cases]]
	The ''Diagram Disable'' structure can have one or more cases, each of which can be ''Enabled'' or ''Disabled''. However, only one subdiagram can be ''Enabled'' at any time.		The ''Diagram Disable'' structure can have one or more cases, each of which can be ''Enabled'' or ''Disabled''. However, only one subdiagram can be ''Enabled'' at any time.
Line 19:		Line 20:
	Only the ''Enabled'' case will be executed, while all other cases will be ignored. The ''Enabled'' case is highlighted in the Case selector with the prefix <tt>[*]</tt>.		Only the ''Enabled'' case will be executed, while all other cases will be ignored. The ''Enabled'' case is highlighted in the Case selector with the prefix <tt>[*]</tt>.

	~~<br clear~~=~~"all">~~		=== Changing the Enabled case ===
	== Changing the Enabled case ==
	[[File:Diagram Disable Structure - Enable This Subdiagram.png\|thumb\|Enable the currently selected subdiagram]]		[[File:Diagram Disable Structure - Enable This Subdiagram.png\|thumb\|Enable the currently selected subdiagram]]
	The ''Enabled'' case can be changed via the right-click menu option '''Enable This Subdiagram''' for disabled cases or '''Disable This Subdiagram''' for the enabled case.		The ''Enabled'' case can be changed via the right-click menu option '''Enable This Subdiagram''' for disabled cases or '''Disable This Subdiagram''' for the enabled case.
Line 32:		Line 32:
	\|}		\|}

	~~<br clear~~=~~"all">~~		=== Similarities with Case structures ===
	== Similarities with Case structures ==

	{{ambox\|type=style\|text=The examples below have indicators ''inside'' structures, which is considered bad practice. They need to be replaced once file versioning works again. --[[User:Logmanoriginal\|Logmanoriginal]] ([[User talk:Logmanoriginal\|talk]]) 20:40, 6 August 2019 (UTC)}}		{{ambox\|type=style\|text=The examples below have indicators ''inside'' structures, which is considered bad practice. They need to be replaced once file versioning works again. --[[User:Logmanoriginal\|Logmanoriginal]] ([[User talk:Logmanoriginal\|talk]]) 20:40, 6 August 2019 (UTC)}}
Line 40:		Line 39:

	[[File:Diagram Disable Structure - Example with Case structure.png\|thumb\|left\|Unreachable code in a Case structure with constant value wired to the Case Selector terminal]]		[[File:Diagram Disable Structure - Example with Case structure.png\|thumb\|left\|Unreachable code in a Case structure with constant value wired to the Case Selector terminal]]
	~~<br clear="all">~~

	A Diagram Disable structure, however, conveys the '''intention''' of the programmer and does not break the VI if a disabled case contains broken code.		A Diagram Disable structure, however, conveys the '''intention''' of the programmer and does not break the VI if a disabled case contains broken code.
Line 49:		Line 47:
	\|}		\|}

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

	* Use Diagram Disable structures instead of Case structures to disable sections of code.		* Use Diagram Disable structures instead of Case structures to disable sections of code.
	* Use Diagram Disable structures to temporarily disable sections of code when [[Debugging\|debugging]] VIs.		* Use Diagram Disable structures to temporarily disable sections of code when [[Debugging\|debugging]] VIs.
Line 70:		Line 66:
	\|}		\|}

	== See ~~also~~ ==		== See Also ==
	* [[DisableStructure class]]		* [[DisableStructure class]]
	* [[Functions Palette/Programming/Structures/Conditional Disable Structure\|Conditional Disable Structure]]		* [[Functions Palette/Programming/Structures/Conditional Disable Structure\|Conditional Disable Structure]]

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

2020-06-23T18:32:16Z

Q moved page Functions Palette/Programming/Structures/Diagram Disable Structure to Diagram 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:25:02Z

Add to Structures Palette

← Older revision		Revision as of 13:25, 15 May 2020
Line 79:		Line 79:

	[[Category:Diagram Disable Structure]]		[[Category:Diagram Disable Structure]]
	[[Category:Structures]]		[[Category:Structures Palette]]
	[[Category:Debugging]]		[[Category:Debugging]]

Q: /* See also */

2019-09-02T03:51:10Z

Logmanoriginal: Cleanup

2019-08-07T06:19:43Z

Cleanup

← Older revision		Revision as of 06:19, 7 August 2019
Line 2:		Line 2:
	[[File:Diagram Disable Structure - Components.png\|thumb\|Components of a Diagram Disable structure]]		[[File:Diagram Disable Structure - Components.png\|thumb\|Components of a Diagram Disable structure]]

	A ''Diagram 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 programmer must manually specify the subdiagram to execute ~~during runtime~~. Disabled subdiagrams do not break a VI if they contain broken wires or SubVIs.		A ''Diagram 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 programmer must manually specify the subdiagram to execute. Disabled subdiagrams do not break a VI if they contain broken wires or SubVIs.

	<br clear="all">		<br clear="all">
Line 17:		Line 17:
	\|}		\|}

	Only the ''Enabled'' case is executed, while all other cases ~~are~~ ignored ~~during execution~~. The ''Enabled'' case is highlighted in the Case selector with the prefix <tt>[*]</tt>.		Only the ''Enabled'' case will be executed, while all other cases will be ignored. The ''Enabled'' case is highlighted in the Case selector with the prefix <tt>[*]</tt>.

	<br clear="all">		<br clear="all">
Line 37:		Line 37:
	{{ambox\|type=style\|text=The examples below have indicators ''inside'' structures, which is considered bad practice. They need to be replaced once file versioning works again. --[[User:Logmanoriginal\|Logmanoriginal]] ([[User talk:Logmanoriginal\|talk]]) 20:40, 6 August 2019 (UTC)}}		{{ambox\|type=style\|text=The examples below have indicators ''inside'' structures, which is considered bad practice. They need to be replaced once file versioning works again. --[[User:Logmanoriginal\|Logmanoriginal]] ([[User talk:Logmanoriginal\|talk]]) 20:40, 6 August 2019 (UTC)}}

	The Diagram Disable structure is similar to the [[Functions Palette/Programming/Structures/Case Structure\|Case structure]]~~, which~~ can ~~also~~ have multiple subdiagrams, one ~~of which is~~ executed at runtime. ~~In fact~~, ~~before~~ the ~~invention~~ of Diagram Disable structures in [[LabVIEW 8\|LabVIEW 8]], Case structures ~~were the only way to disable code by wiring~~ a constant value to the Case Selector terminal.<ref>[https://knowledge.ni.com/KnowledgeArticleDetails?id=kA00Z000000P9NASA0 NI Knowledge Base: Comment Out or Disable Pieces of Code in LabVIEW]</ref> In that regard, Case structures work the same as Diagram Disable structures.		The Diagram Disable structure is similar to the [[Functions Palette/Programming/Structures/Case Structure\|Case structure]]. Both can have multiple subdiagrams and only one will be executed at runtime. The key difference is, that Case structures are evaluated at runtime while Diagram Disable structures are evaluated at compile-time. Before the addition of Diagram Disable structures in [[LabVIEW 8\|LabVIEW 8]], Case structures with a constant value wired to the Case Selector terminal were the only way to disable code.<ref>[https://knowledge.ni.com/KnowledgeArticleDetails?id=kA00Z000000P9NASA0 NI Knowledge Base: Comment Out or Disable Pieces of Code in LabVIEW]</ref> In that regard, Case structures work the same as Diagram Disable structures.

	[[File:Diagram Disable Structure - Example with Case structure.png\|thumb\|left\|Unreachable code in a Case structure with constant value wired to the Case Selector terminal]]		[[File:Diagram Disable Structure - Example with Case structure.png\|thumb\|left\|Unreachable code in a Case structure with constant value wired to the Case Selector terminal]]
	<br clear="all">		<br clear="all">

	A Diagram Disable structure, however, conveys the '''intention''' of the programmer and does not break a VI if ~~the code inside~~ a disabled case ~~breaks~~.		A Diagram Disable structure, however, conveys the '''intention''' of the programmer and does not break the VI if a disabled case contains broken code.

	{\|		{\|

Logmanoriginal: Add new page

2019-08-06T20:40:40Z

Add new page

New page

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

A ''Diagram 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 programmer must manually specify the subdiagram to execute during runtime. Disabled subdiagrams do not break a VI if they contain broken wires or SubVIs.

 
== Code execution ==
[[File:Diagram Disable Structure - Case selector with two disabled cases.png|thumb|Diagram Disable structure with two disabled cases]]
The ''Diagram Disable'' structure can have one or more cases, each of which can be ''Enabled'' or ''Disabled''. However, only one subdiagram can be ''Enabled'' at any time.

{| class="wikitable"
! Enabled
| The subdiagram will be executed at runtime.
|-
! Disabled
| The subdiagram will be ignored.
|}

Only the ''Enabled'' case is executed, while all other cases are ignored during execution. The ''Enabled'' case is highlighted in the Case selector with the prefix <tt>[*]</tt>.

 
== Changing the Enabled case ==
[[File:Diagram Disable Structure - Enable This Subdiagram.png|thumb|Enable the currently selected subdiagram]]
The ''Enabled'' case can be changed via the right-click menu option '''Enable This Subdiagram''' for disabled cases or '''Disable This Subdiagram''' for the enabled case.

{| class="wikitable"
! Enable This Subdiagram
| Enables the currently selected subdiagram (must be disabled) and disables all other subdiagrams.
|-
! Disable This Subdiagram
| Disables the currently selected subdiagram (must be enabled).
|}

 
== Similarities with Case structures ==

{{ambox|type=style|text=The examples below have indicators ''inside'' structures, which is considered bad practice. They need to be replaced once file versioning works again. --[[User:Logmanoriginal|Logmanoriginal]] ([[User talk:Logmanoriginal|talk]]) 20:40, 6 August 2019 (UTC)}}

The Diagram Disable structure is similar to the [[Functions Palette/Programming/Structures/Case Structure|Case structure]], which can also have multiple subdiagrams, one of which is executed at runtime. In fact, before the invention of Diagram Disable structures in [[LabVIEW 8|LabVIEW 8]], Case structures were the only way to disable code by wiring a constant value to the Case Selector terminal.<ref>[https://knowledge.ni.com/KnowledgeArticleDetails?id=kA00Z000000P9NASA0 NI Knowledge Base: Comment Out or Disable Pieces of Code in LabVIEW]</ref> In that regard, Case structures work the same as Diagram Disable structures.

[[File:Diagram Disable Structure - Example with Case structure.png|thumb|left|Unreachable code in a Case structure with constant value wired to the Case Selector terminal]]
 

A Diagram Disable structure, however, conveys the '''intention''' of the programmer and does not break a VI if the code inside a disabled case breaks.

{|
| [[File:Diagram Disable Structure - Compare to Case structure 1.png|thumb|center|Broken disabled code in a Diagram Disable structure does not break the VI]]
| [[File:Diagram Disable Structure - Compare to Case structure 2.png|thumb|center|Broken disabled code in a Case structure with constant value wired to the Case Selector terminal breaks the VI]]
|}

 
== Best practice ==

* Use Diagram Disable structures instead of Case structures to disable sections of code.
* Use Diagram Disable structures to temporarily disable sections of code when [[Debugging|debugging]] VIs.
* Use a [[Version Control Systems|version control system]] instead of Diagram Disable structures to manage code revisions.
* Use [[Functions Palette/Programming/Structures/Conditional Disable Structure|Conditional Disable structures]] instead of Diagram Disable structures to enable/disable subdiagrams based on compile-time conditions.

== History ==

{| class="wikitable"
! Version
! Change(s)
|-
| [[File:LV2019.png|frameless|border|64x64px|LabVIEW 2019|link=LabVIEW 2019]]
| The Diagram Disable structure can automatically be replaced by a [[Functions Palette/Programming/Structures/Type Specialization Structure|Type Specialization Structure]]
|-
| [[File:LV8-2013.png|frameless|border|64x64px|LabVIEW 8|link=LabVIEW 8]]
| The ''Diagram Disable'' structure was added.
|}

== See also ==

* [[Functions Palette/Programming/Structures/Conditional Disable Structure|Conditional Disable Structure]]
* [[Functions Palette/Programming/Structures/Type Specialization Structure|Type Specialization Structure]]

== References ==
<references />

[[Category:Diagram Disable Structure]]
[[Category:Structures]]
[[Category:Debugging]]

← Older revision		Revision as of 03:51, 2 September 2019
Line 71:		Line 71:

	== See also ==		== See also ==
			* [[DisableStructure class]]
	* [[Functions Palette/Programming/Structures/Conditional Disable Structure\|Conditional Disable Structure]]		* [[Functions Palette/Programming/Structures/Conditional Disable Structure\|Conditional Disable Structure]]
	* [[Functions Palette/Programming/Structures/Type Specialization Structure\|Type Specialization Structure]]		* [[Functions Palette/Programming/Structures/Type Specialization Structure\|Type Specialization Structure]]