Jump to content

ForLoop class: Difference between revisions

From LabVIEW Wiki
Started page
 
Updated for LabVIEW 2020. Removed template.
 
(5 intermediate revisions by the same user not shown)
Line 7: Line 7:
{{TOCright}}
{{TOCright}}


==Properties==
== Properties ==
<span class="mw-customtoggle-propertiestable">Show/Hide ForLoop Properties Table</span>
<span class="mw-customtoggle-propertiestable">Show/Hide ForLoop 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"  
|+ ForLoop Properties Table
|+ ForLoop 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;"  
|6362008
| data-sort-value=104210432 |6362000
| [[ForLoop class/ChunkSizeTunnel property|ChunkSizeTunnel]]
| [[ForLoop class/Loop Count property|Loop Count]]
|Returns a reference to the chunk size (<b>C</b>) terminal of the For Loop.
| Returns a reference to the loop count.
|R
| Read Only
|
| No
|- style="background-color:#CCFFFF;"
|- style="background-color:#CCFFFF;"  
|6362006
| data-sort-value=104210433 |6362001
| [[ForLoop class/DynamicParInstancesTunnel property|DynamicParInstancesTunnel]]
| [[ForLoop class/Has Conditional Terminal? property|Has Conditional Terminal?]]
|Returns a reference to the tunnel for the dynamic number of parallel instances of the For Loop.
| Creates the conditional terminal if you set this property TRUE. If the conditional terminal already exists, this property does nothing and does not return an error. If you set this property to FALSE, this property removes the conditional terminal, possibly leaving broken wires. If the conditional terminal does not already exist, this property does nothing and does not return an error.
|R
| Read/Write
|
| Yes
|- style="background-color:#CCFFFF;"
|- style="background-color:#CCFFFF;"  
|6362001
| data-sort-value=104210434 |6362002
| [[ForLoop class/HasCondTerm property|HasCondTerm]]
| [[ForLoop class/Loop End Ref property|Loop End Ref]]
|Creates the conditional terminal if you set this property TRUE. If the conditional terminal already exists, this property does nothing and does not return an error. If you set this property to FALSE, this property removes the conditional terminal, possibly leaving broken wires. If the conditional terminal does not already exist, this property does nothing and does not return an error.
| Returns a reference to the end terminal of the [[For Loop]].
|R/W
| Read Only
|X
| No
|- style="background-color:#CCFFFF;"
|- style="background-color:#CCFFFF;"
|6362007
| data-sort-value=104210435 |6362003
| [[ForLoop class/IsDebuggingAllowed property|IsDebuggingAllowed]]
| [[ForLoop class/Stop If True? property|Stop If True?]]
|If TRUE, allows debugging inside the For Loop by setting the loop iterations to run sequentially. If FALSE, debugging is not allowed in the For Loop.
| Specifies whether the [[For Loop]] stops if you wire TRUE to the end terminal of the loop.
 
| Read/Write
This property applies only to For Loops with parallel loop iterations enabled.
| No
|R/W
|- style="background-color:#CCFFFF;"  
|
| data-sort-value=104210436 |6362004
|- style="background-color:#CCFFFF;"
| [[ForLoop class/Is Parallelism Enabled? property|Is Parallelism Enabled?]]
|6362004
| If TRUE, this property enables parallel loop iterations. If parallel loop iterations already are enabled, this property does nothing, and LabVIEW does not return an error. If FALSE, this property disables parallel loop iterations, which might break wires. If parallel loop iterations already are disabled, this property does nothing, and LabVIEW does not return an error.
| [[ForLoop class/IsParallelismEnabled property|IsParallelismEnabled]]
| Read/Write
|If TRUE, this property enables parallel loop iterations. If parallel loop iterations already are enabled, this property does nothing, and LabVIEW does not return an error. If FALSE, this property disables parallel loop iterations, which might break wires. If parallel loop iterations already are disabled, this property does nothing, and LabVIEW does not return an error.
| Yes
|R/W
|- style="background-color:#CCFFFF;"  
|X
| data-sort-value=104210437 |6362005
|- style="background-color:#CCFFFF;"
| [[ForLoop class/Number of Static Parallel Instances property|Number of Static Parallel Instances]]
|6362000
| Specifies the number of loop instances LabVIEW uses to run [[parallel loop iterations]].
| [[ForLoop class/LoopCount property|LoopCount]]
| Read/Write
|Returns a reference to the loop count.
| No
|R
|- style="background-color:#CCFFFF;"  
|
| data-sort-value=104210438 |6362006
|- style="background-color:#CCFFFF;"
| [[ForLoop class/Dynamic Parallel Instances Tunnel property|Dynamic Parallel Instances Tunnel]]
|6362002
| Returns a reference to the tunnel for the dynamic number of parallel instances of the For Loop.
| [[ForLoop class/LoopEndRef property|LoopEndRef]]
| Read Only
|Returns a reference to the end terminal of the For Loop.
| No
|R
|- style="background-color:#CCFFFF;"  
|
| data-sort-value=104210439 |6362007
|- style="background-color:#CCFFFF;"
| [[ForLoop class/Is Debugging Allowed property|Is Debugging Allowed]]
|6362005
| If TRUE, allows debugging inside the [[For Loop]] by setting the loop iterations to run sequentially. If FALSE, debugging is not allowed in the For Loop.
| [[ForLoop class/NumStaticParInstances property|NumStaticParInstances]]
| Read/Write
|Specifies the number of loop instances LabVIEW uses to run parallel loop iterations.
| No
|R/W
|- style="background-color:#CCFFFF;"  
|
| data-sort-value=104210440 |6362008
|- style="background-color:#CCFFFF;"
| [[ForLoop class/Chunk Size Tunnel property|Chunk Size Tunnel]]
|6362009
| Returns a reference to the chunk size ('''C''') terminal of the [[For Loop]].
| [[ForLoop class/ParallelSchedule property|ParallelSchedule]]
| Read Only
|Sets the parallel loop iteration schedule of the For Loop when you enable parallelism.
| No
|R/W
|- style="background-color:#CCFFFF;"
|
| data-sort-value=104210441 |6362009
|- style="background-color:#CCFFFF;"
| [[ForLoop class/Parallel Schedule property|Parallel Schedule]]
|6362003
| Sets the parallel loop iteration schedule of the [[For Loop]] when you enable parallelism.
| [[ForLoop class/StopIfTrue property|StopIfTrue]]
| Read/Write
|Specifies whether the For Loop stops if you wire TRUE to the end terminal of the loop.
| No
|R/W
|- style="background-color:#CCFFFF;"  
|
| data-sort-value=104210442 |636200A
| [[ForLoop 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 ==
''No Methods for this class.''
''This class has no methods or it inherits methods from its parent: [[Loop class#Methods|Loop Class]].''


==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 [[ForLoop class/Iteration Terminal Hidden? property|Iteration Terminal Hidden? property]] added in [[LabVIEW 2020]].
|}
|}


== See Also ==
== See Also ==
*[[Functions Palette/Programming/Structures/For Loop|For 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:29, 15 June 2020

VI Server Class Information
Return to VI Server Class Hierarchy
Class Name ForLoop class
Class ID 16434
Scope VI Scripting
Class Inheritance
Class Children

This class has no children.


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

    Properties

    Show/Hide ForLoop Properties Table

    Legend
    R/WReadable/Writable Permissions
    RTEAvailable in the Run-Time Engine
    Basic Development Environment
    VI Scripting
    Private
    Deprecated
    ForLoop Properties Table
    Property ID Long Name (English) Description R/W RTE
    6362000 Loop Count Returns a reference to the loop count. Read Only No
    6362001 Has Conditional Terminal? Creates the conditional terminal if you set this property TRUE. If the conditional terminal already exists, this property does nothing and does not return an error. If you set this property to FALSE, this property removes the conditional terminal, possibly leaving broken wires. If the conditional terminal does not already exist, this property does nothing and does not return an error. Read/Write Yes
    6362002 Loop End Ref Returns a reference to the end terminal of the For Loop. Read Only No
    6362003 Stop If True? Specifies whether the For Loop stops if you wire TRUE to the end terminal of the loop. Read/Write No
    6362004 Is Parallelism Enabled? If TRUE, this property enables parallel loop iterations. If parallel loop iterations already are enabled, this property does nothing, and LabVIEW does not return an error. If FALSE, this property disables parallel loop iterations, which might break wires. If parallel loop iterations already are disabled, this property does nothing, and LabVIEW does not return an error. Read/Write Yes
    6362005 Number of Static Parallel Instances Specifies the number of loop instances LabVIEW uses to run parallel loop iterations. Read/Write No
    6362006 Dynamic Parallel Instances Tunnel Returns a reference to the tunnel for the dynamic number of parallel instances of the For Loop. Read Only No
    6362007 Is Debugging Allowed If TRUE, allows debugging inside the For Loop by setting the loop iterations to run sequentially. If FALSE, debugging is not allowed in the For Loop. Read/Write No
    6362008 Chunk Size Tunnel Returns a reference to the chunk size (C) terminal of the For Loop. Read Only No
    6362009 Parallel Schedule Sets the parallel loop iteration schedule of the For Loop when you enable parallelism. Read/Write No
    636200A 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

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

    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