Jump to content

FeedbackNode class: Difference between revisions

From LabVIEW Wiki
Started page
 
m Removed VI Server Category from page
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{VIServerClass|name=FeedbackNode|id=16522|scope=script|class_0=Generic|class_1=GObject|class_2=Node|class_3=FeedbackNode}}
{{VIServerClass|16522}}


{{stub}}
{{stub}}
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 FeedbackNode Properties Table</span>
{{VIServerClassTables|16522}}
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{| class="wikitable sortable"
|+ FeedbackNode Properties Table
! Property ID
! Short Name (English)
! Description
! R/W
! RTE
|- style="background-color:#CCFFFF;"
|778ED406
| [[FeedbackNode class/Delay property|Delay]]
|Gets or sets the value of the Feedback Node delay.  If the delay is less than 1, LabVIEW returns an error.
|R/W
|X
|- style="background-color:#CCFFFF;"
|778ED400
| [[FeedbackNode class/Dir property|Dir]]
|Gets and sets the direction the Feedback Node faces.
|R/W
|
|- style="background-color:#D1BB80;"
|778ED40B
| [[FeedbackNode class/DisconnectEnable property|DisconnectEnable]]
|
|R/W
|X
|- style="background-color:#CCFFFF;"
|778ED407
| [[FeedbackNode class/EnableTerm? property|EnableTerm?]]
|Gets or sets whether the enable terminal of the Feedback Node is shown.
|R/W
|X
|- style="background-color:#CCFFFF;"
|778ED409
| [[FeedbackNode class/Header property|Header]]
|Gets or sets the cosmetic appearance of the Feedback Node.
 
Using this property to set the appearance is similar to right-clicking a Feedback Node and enabling or disabling the <b>Z-Transform View</b> item in the shortcut menu.
|R/W
|X
|- style="background-color:#CCFFFF;"
|778ED40A
| [[FeedbackNode class/IgnoreReset property|IgnoreReset]]
|Gets or sets whether this Feedback Node initializes if the FPGA VI resets. If TRUE, this node does not initialize if the FPGA VI resets. This node initializes the next time you download the FPGA VI to the FPGA target. This property applies only when the Feedback Node is deployed on an FPGA target. This property can have a value of TRUE only when the initialization style of the Feedback Node is to initialize on compile or load.
 
If you write a value of TRUE, ensure the application does not depend on the value this Feedback Node returns on the first call after resetting the FPGA VI.
|R/W
|X
|- style="background-color:#CCFFFF;"
|778ED40C
| [[FeedbackNode class/InitMuxLocation property|InitMuxLocation]]
|Controls where the initialization multiplexer is relative to the core feedback register when the containing VI is targeted to FPGA. The multiplexer can only be before the register if a constant is wired in to the initialization terminal. This option only applies if the feedback node is globally initialized.
|R/W
|X
|- style="background-color:#CCFFFF;"
|778ED408
| [[FeedbackNode class/InitType property|InitType]]
|Places the initializer terminal on the innermost loop. When you first call this method, or when LabVIEW compiles or loads the VI that contains the loop, LabVIEW places the terminal on the node and sets the initialization mode appropriately.
|R/W
|X
|- style="background-color:#CCFFFF;"
|778ED405
| [[FeedbackNode class/InitOnLoop property|InitOnLoop]]
|Returns TRUE if the initializer terminal of the Feedback Node is on a loop and not globally initialized on the first call of the VI in an execution or when the VI it belongs to compiles or loads.
|R
|
|- style="background-color:#CCFFFF;"
|778ED403
| [[FeedbackNode class/InitTerm property|InitTerm]]
|Returns a reference to the initializer terminal of the Feedback Node.
|R
|
|- style="background-color:#CCFFFF;"
|778ED404
| [[FeedbackNode class/InitializersLoop property|InitializersLoop]]
|Gets or sets a reference to the loop to which the initializer is currently attached, or an invalid reference if the initializer is not on a loop and will be globally initialized.
|R/W
|
|- style="background-color:#CCFFFF;"
|778ED402
| [[FeedbackNode class/InputTerm property|InputTerm]]
|Returns a reference to the input terminal of the Feedback Node. The input terminal of a Feedback Node provides the output value for the node the next time the VI runs.
|R
|
|- style="background-color:#CCFFFF;"
|778ED401
| [[FeedbackNode class/OutputTerm property|OutputTerm]]
|Returns a reference to the output terminal of the Feedback Node.
|R
|
|}
</div>
 
==Methods==
<span class="mw-customtoggle-methodstable">Show/Hide FeedbackNode Methods Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-methodstable">
{{VIServerLegend|showrte=TRUE}}
{| class="wikitable sortable"
|+ FeedbackNode Methods Table
! Method ID
! Short Name (English)
! Description
! RTE
|- style="background-color:#CCFFFF;"
|778ED001
| [[FeedbackNode class/HighlightInit method|HighlightInit]]
|Scrolls to and highlights the initializer of the Feedback Node. To perform the same action with the rest of the Feedback Node, use the Object Highlight method.
|
|- style="background-color:#CCFFFF;"
|778ED000
| [[FeedbackNode class/RepWithShiftReg method|RepWithShiftReg]]
|Changes a Feedback Node inside a loop into a shift register. LabVIEW returns an error if the Feedback Node is not within a loop.
 
If the Feedback Node initializer terminal is on a loop, LabVIEW adds the shift register to that loop. If the initializer terminal is not on a loop, LabVIEW adds the shift register to the innermost loop that contains the Feedback Node.
 
<b>Note</b>  After this method executes, the reference to the Feedback Node is no longer valid.
|
|}
</div>
 
==Events==
''No Events for this class.''


== History ==
== History ==
Line 148: Line 25:
*[[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 02:10, 8 May 2020

VI Server Class Information
Return to VI Server Class Hierarchy
Class Name FeedbackNode class
Class ID 16522
Scope VI Scripting
Class Inheritance
Class Children

This class has no children.


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

Properties

Show/Hide FeedbackNode Properties Table

Legend
R/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
FeedbackNode Properties Table
Property ID Long Name (English) Description R/W RTE
778ED400DirectionGets and sets the direction the Feedback Node faces.Read/WriteNo
778ED401Output TerminalReturns a reference to the output terminal of the Feedback Node.Read OnlyNo
778ED402Input TerminalReturns a reference to the input terminal of the Feedback Node. The input terminal of a Feedback Node provides the output value for the node the next time the VI runs.Read OnlyNo
778ED403Initializer TerminalReturns a reference to the initializer terminal of the Feedback Node.Read OnlyNo
778ED404Initializer's LoopGets or sets a reference to the loop to which the initializer is currently attached, or an invalid reference if the initializer is not on a loop and will be globally initialized.Read/WriteNo
778ED405Initializer Is On LoopReturns TRUE if the initializer terminal of the Feedback Node is on a loop and not globally initialized on the first call of the VI in an execution or when the VI it belongs to compiles or loads.Read OnlyNo
778ED406DelayGets or sets the value of the Feedback Node delay. If the delay is less than 1, LabVIEW returns an error.Read/WriteYes
778ED407Enable Terminal ShownGets or sets whether the enable terminal of the Feedback Node is shown.Read/WriteYes
778ED408Initialization TypePlaces the initializer terminal on the innermost loop. When you first call this method, or when LabVIEW compiles or loads the VI that contains the loop, LabVIEW places the terminal on the node and sets the initialization mode appropriately.Read/WriteYes
778ED409Header AppearanceGets or sets the cosmetic appearance of the Feedback Node.Read/WriteYes
778ED40AIgnore FPGA Reset MethodGets or sets whether this Feedback Node initializes if the FPGA VI resets. If TRUE, this node does not initialize if the FPGA VI resets. This node initializes the next time you download the FPGA VI to the FPGA target. This property applies only when the Feedback Node is deployed on an FPGA target. This property can have a value of TRUE only when the initialization style of the Feedback Node is to initialize on compile or load.Read/WriteYes
778ED40BDisconnect Implicit Enable SignalRead/WriteYes
778ED40CInitialization Mux LocationControls where the initialization multiplexer is relative to the core feedback register when the containing VI is targeted to FPGA. The multiplexer can only be before the register if a constant is wired in to the initialization terminal. This option only applies if the feedback node is globally initialized.Read/WriteYes

Methods

Show/Hide FeedbackNode Properties Table

Legend
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
FeedbackNode Methods Table
Method ID Long Name (English) Description RTE
778ED000Replace With Shift RegisterChanges a Feedback Node inside a loop into a shift register. LabVIEW returns an error if the Feedback Node is not within a loop.No
778ED001Highlight InitializerScrolls to and highlights the initializer of the Feedback Node. To perform the same action with the rest of the Feedback Node, use the Object Highlight method.No

Events

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


History

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

See Also