Jump to content

ForLoop class: Difference between revisions

From LabVIEW Wiki
mNo edit summary
Replaced with template tables
Line 7: Line 7:
{{TOCright}}
{{TOCright}}


==Properties==
<!--Edit Properties, Methods, or Events in the appropriate table in one on the VI Server Templates-->
<span class="mw-customtoggle-propertiestable">Show/Hide ForLoop Properties Table</span>
{{VIServerClassTables|16434}}
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{| class="wikitable sortable"
|+ ForLoop Properties Table
! Property ID
! Short Name (English)
! Description
! R/W
! RTE
|- style="background-color:#CCFFFF;"
|6362008
| [[ForLoop class/ChunkSizeTunnel property|ChunkSizeTunnel]]
|Returns a reference to the chunk size (<b>C</b>) terminal of the For Loop.
|R
|
|- style="background-color:#CCFFFF;"
|6362006
| [[ForLoop class/DynamicParInstancesTunnel property|DynamicParInstancesTunnel]]
|Returns a reference to the tunnel for the dynamic number of parallel instances of the For Loop.
|R
|
|- style="background-color:#CCFFFF;"
|6362001
| [[ForLoop class/HasCondTerm property|HasCondTerm]]
|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/W
|X
|- style="background-color:#CCFFFF;"
|6362007
| [[ForLoop class/IsDebuggingAllowed property|IsDebuggingAllowed]]
|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.
 
This property applies only to For Loops with parallel loop iterations enabled.
|R/W
|
|- style="background-color:#CCFFFF;"
|6362004
| [[ForLoop class/IsParallelismEnabled property|IsParallelismEnabled]]
|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.
|R/W
|X
|- style="background-color:#CCFFFF;"
|6362000
| [[ForLoop class/LoopCount property|LoopCount]]
|Returns a reference to the loop count.
|R
|
|- style="background-color:#CCFFFF;"
|6362002
| [[ForLoop class/LoopEndRef property|LoopEndRef]]
|Returns a reference to the end terminal of the For Loop.
|R
|
|- style="background-color:#CCFFFF;"
|6362005
| [[ForLoop class/NumStaticParInstances property|NumStaticParInstances]]
|Specifies the number of loop instances LabVIEW uses to run parallel loop iterations.
|R/W
|
|- style="background-color:#CCFFFF;"
|6362009
| [[ForLoop class/ParallelSchedule property|ParallelSchedule]]
|Sets the parallel loop iteration schedule of the For Loop when you enable parallelism.
|R/W
|
|- style="background-color:#CCFFFF;"
|6362003
| [[ForLoop class/StopIfTrue property|StopIfTrue]]
|Specifies whether the For Loop stops if you wire TRUE to the end terminal of the loop.
|R/W
|
|}
</div>
 
==Methods==
''No Methods for this class.''
 
==Events==
''No Events for this class.''


== History ==
== History ==

Revision as of 00:33, 9 September 2019

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
    6362000Loop CountReturns a reference to the loop count.Read OnlyNo
    6362001Has 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/WriteYes
    6362002Loop End RefReturns a reference to the end terminal of the For Loop.Read OnlyNo
    6362003Stop If True?Specifies whether the For Loop stops if you wire TRUE to the end terminal of the loop.Read/WriteNo
    6362004Is 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/WriteYes
    6362005Number of Static Parallel InstancesSpecifies the number of loop instances LabVIEW uses to run parallel loop iterations.Read/WriteNo
    6362006Dynamic Parallel Instances TunnelReturns a reference to the tunnel for the dynamic number of parallel instances of the For Loop.Read OnlyNo
    6362007Is Debugging AllowedIf 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/WriteNo
    6362008Chunk Size TunnelReturns a reference to the chunk size (C) terminal of the For Loop.Read OnlyNo
    6362009Parallel ScheduleSets the parallel loop iteration schedule of the For Loop when you enable parallelism.Read/WriteNo

    Methods

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

    Events

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


    History

    Version Change(s)
    LabVIEW 2018 More info to come.

    See Also