Jump to content

WhileLoop class: Difference between revisions

From LabVIEW Wiki
VisualWikitext
Started page
 
Removed template
 
(6 intermediate revisions by the same user not shown)
Line 7: Line 7:
{{TOCright}}
{{TOCright}}


==Properties==
== Properties ==
<span class="mw-customtoggle-propertiestable">Show/Hide WhileLoop Properties Table</span>
<span class="mw-customtoggle-propertiestable">Show/Hide WhileLoop Properties Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{| class="wikitable sortable"
<div style="width: 80%; max-height: 50em; overflow: auto;">
{| class="wikitable sortable"  
|+ WhileLoop Properties Table
|+ WhileLoop Properties Table
! Property ID
! data-sort-type="number"| Property ID
! Short Name (English)
! Long Name (English)
! Description
! Description
! R/W
! R/W
! RTE
! RTE  
|- style="background-color:#CCFFFF;"
|- style="background-color:#CCFFFF;"  
|6362C00
| data-sort-value=104213504 |6362C00
| [[WhileLoop class/LoopEndRef property|LoopEndRef]]
| [[WhileLoop class/Loop End Ref property|Loop End Ref]]
|Returns a reference to the end terminal of the While Loop.
| Returns a reference to the end terminal of the [[While Loop]].
|R
| Read Only
|
| No
|- style="background-color:#CCFFFF;"
|- style="background-color:#CCFFFF;"  
|6362C01
| data-sort-value=104213505 |6362C01
| [[WhileLoop class/StopIfTrue property|StopIfTrue]]
| [[WhileLoop class/Stop If True? property|Stop If True?]]
|Specifies whether the While Loop stops if you wire TRUE to the end terminal of the loop.
| Specifies whether the [[While Loop]] stops if you wire TRUE to the end terminal of the loop.
|R/W
| Read/Write
|
| No
|- style="background-color:#CCFFFF;"
| data-sort-value=104213506 |6362C02
| [[WhileLoop class/Iteration Terminal Hidden? property|Iteration Terminal Hidden?]]
| Hides the iteration terminal if you set this property TRUE. Returns an error if you try to hide the iteration terminal when it is wired.
| Read/Write
| Yes
|}
|}
</div>
</div></div>


==Methods==
== Methods ==
<span class="mw-customtoggle-methodstable">Show/Hide WhileLoop Methods Table</span>
<span class="mw-customtoggle-methodstable">Show/Hide WhileLoop Methods Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-methodstable">
<div class="mw-collapsible" id="mw-customcollapsible-methodstable">
{{VIServerLegend|showrte=TRUE}}
{{VIServerLegend|showrte=TRUE}}
<div style="width: 80%; max-height: 50em; overflow: auto;">
{| class="wikitable sortable"
{| class="wikitable sortable"
|+ WhileLoop Methods Table
|+ WhileLoop Methods Table
! Method ID
! data-sort-type="number"| Property ID
! Short Name (English)
! Long Name (English)
! Description
! Description
! RTE
! RTE  
|- style="background-color:#CCFFFF;"
|- style="background-color:#CCFFFF;"  
|6362800
| data-sort-value=104212480 |6362800
| [[WhileLoop class/Replace With TimeLoop method|Replace With TimeLoop]]
| [[WhileLoop class/Replace With TimeLoop method|Replace With TimeLoop]]
|Replaces a While Loop with a Timed Loop.
| Replaces a [[While Loop]] with a [[Timed Loop]].
|X
| Yes
|}
|}
</div>
</div></div>


==Events==
== Event ==
''No Events for this class.''
''This class has no events or it inherits events from its parent: [[Loop class#Events|Loop Class]].''


== History ==
== History ==
{{ambox|text=History information is needed.  What changes have occurred over previous versions?}}
{| class="wikitable"
{| class="wikitable"
! Version
! Version
! Change(s)
! Change(s)
|-
|-
|[[File:LV2018.png|frameless|border|64x64px|LabVIEW 2018|link=LabVIEW 2018]]
|[[File:LV2020.png|frameless|border|64x64px|LabVIEW 2020|link=LabVIEW 2020]]
|More info to come.
| The [[WhileLoop class/Iteration Terminal Hidden? property|Iteration Terminal Hidden? property]] added in [[LabVIEW 2020]].
|}
|}


== See Also ==
== See Also ==
* [[Functions Palette/Programming/Structures/While Loop|While Loop]]
*[[VI Server Class Hierarchy]]
*[[VI Server Class Hierarchy]]
*[[VI Server]]
*[[VI Server]]
*[[VI Scripting]]
*[[VI Scripting]]


[[Category:VI Server]]
[[Category:VI Scripting Class]]
[[Category:VI Server Class]]
[[Category:VI Server Class]]
[[Category:VI Scripting]]

Latest revision as of 20:40, 15 June 2020

VI Server Class Information
Return to VI Server Class Hierarchy
Class Name WhileLoop class
Class ID 16435
Scope VI Scripting
Class Inheritance
Class Children


This article is a stub. You can help LabVIEW Wiki by expanding it.
Please improve this article if you can.

The WhileLoop class is a class in the VI Server Class Hierarchy, (see also VI Server).

Properties

Show/Hide WhileLoop Properties Table

Legend
R/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
WhileLoop Properties Table
Property ID Long Name (English) Description R/W RTE
6362C00 Loop End Ref Returns a reference to the end terminal of the While Loop. Read Only No
6362C01 Stop If True? Specifies whether the While Loop stops if you wire TRUE to the end terminal of the loop. Read/Write No
6362C02 Iteration Terminal Hidden? Hides the iteration terminal if you set this property TRUE. Returns an error if you try to hide the iteration terminal when it is wired. Read/Write Yes

Methods

Show/Hide WhileLoop Methods Table

Legend
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
WhileLoop Methods Table
Property ID Long Name (English) Description RTE
6362800 Replace With TimeLoop Replaces a While Loop with a Timed Loop. Yes

Event

This class has no events or it inherits events from its parent: Loop Class.

History

Version Change(s)
LabVIEW 2020 The Iteration Terminal Hidden? property added in LabVIEW 2020.

See Also

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