Jump to content

Node class: Difference between revisions

From LabVIEW Wiki
VisualWikitext
Started page
 
Removed template
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{VIServerClass|name=Node|id=16421|scope=script|class_0=Generic|class_1=GObject|class_2=Node}}
{{VIServerClass|16421}}


{{stub}}
{{stub}}
Line 7: Line 7:
{{TOCright}}
{{TOCright}}


==Properties==
== Properties ==
<span class="mw-customtoggle-propertiestable">Show/Hide Node Properties Table</span>
<span class="mw-customtoggle-propertiestable">Show/Hide Node 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"  
|+ Node Properties Table
|+ Node 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;"  
|635900C
| data-sort-value=104173568 |6359000
| [[Node class/BreakPtStatus property|BreakPtStatus]]
| [[Node class/Terminals() property|Terminals[]]]
|Gets or sets the status of a breakpoint on a node.
| Array of references to the terminals of the node. To locate a specific terminal reference within the array, use the [[terminal index displayed in the Context Help window]] for the node.
|R/W
| Read Only
|
| No
|- style="background-color:#D1BB80;"
|- style="background-color:#CCFFFF;"  
|6359004
| data-sort-value=104173569 |6359001
| [[Node class/ClumpNum property|ClumpNum]]
| [[Node class/Label property|Label]]
|
| Returns a reference to the label of the node. You must display the label at least once before this property can return the text of the label.
|R
| Read Only
|
| No
|- style="background-color:#CCFFFF;"
|- style="background-color:#CCFFFF;"  
|6359002
| data-sort-value=104173570 |6359002
| [[Node class/Desc property|Desc]]
| [[Node class/Description property|Description]]
|Gets or sets the description of the node.
| Gets or sets the description of the node.
|R/W
| Read/Write
|
| No
|- style="background-color:#D1BB80;"
|- style="background-color:#FFAAAA;"
|6359006
| data-sort-value=104173571 |6359003
| [[Node class/FireCount property|FireCount]]
| [[Node class/Is Break Point Set property|Is Break Point Set]]
|
|
|R
| Read/Write
|
| No
|- style="background-color:#CCFFFF;"
|- style="background-color:#D1BB80;"  
|6359008
| data-sort-value=104173572 |6359004
| [[Node class/Clump Num property|Clump Num]]
|
| Read Only
| No
|- style="background-color:#D1BB80;"
| data-sort-value=104173573 |6359005
| [[Node class/Short Count property|Short Count]]
|
| Read Only
| No
|- style="background-color:#D1BB80;"
| data-sort-value=104173574 |6359006
| [[Node class/Fire Count property|Fire Count]]
|
| Read Only
| No
|- style="background-color:#D1BB80;"
| data-sort-value=104173575 |6359007
| [[Node class/Is Asynchronous property|Is Asynchronous]]
|  
| Read Only
| No
|- style="background-color:#CCFFFF;"  
| data-sort-value=104173576 |6359008
| [[Node class/Icon property|Icon]]
| [[Node class/Icon property|Icon]]
|Returns the icon for the node. For structure nodes, this property returns the 32 x 32 pixel icon seen on the palettes.
| Returns the icon for the node. For structure nodes, this property returns the 32 x 32 pixel icon seen on the palettes.
|R
| Read Only
|
| No
|- style="background-color:#D1BB80;"
|- style="background-color:#CCFFFF;"  
|6359007
| data-sort-value=104173577 |6359009
| [[Node class/IsAsync property|IsAsync]]
|
|R
|
|- style="background-color:#D1BB80;"
|635900A
| [[Node class/IsRunAtAnyLoop property|IsRunAtAnyLoop]]
|
|R
|X
|- style="background-color:#CCFFFF;"
|6359001
| [[Node class/Label property|Label]]
|Returns a reference to the label of the node. You must display the label at least once before this property can return the text of the label.
|R
|
|- style="background-color:#D1BB80;"
|6359005
| [[Node class/ShortCount property|ShortCount]]
|
|R
|
|- style="background-color:#CCFFFF;"
|6359009
| [[Node class/Style property|Style]]
| [[Node class/Style property|Style]]
|Returns the type of node.
| Returns the type of node.
|R
| Read Only
|
| No
|- style="background-color:#CCFFFF;"
|- style="background-color:#D1BB80;"  
|6359000
| data-sort-value=104173578 |635900A
| [[Node class/Terms() property|Terms()]]
| [[Node class/Is Run At Any Loop property|Is Run At Any Loop]]
|Array of references to the terminals of the node. To locate a specific terminal reference within the array, use the terminal index displayed in the Context Help window for the node.
|  
|R
| Read Only
|
| Yes
|- style="background-color:#D1BB80;"
|- style="background-color:#CCFFFF;"  
|635900B
| data-sort-value=104173579 |635900B
| [[Node class/Visible property|Visible]]
| [[Node class/Visible property|Visible]]
|
| Gets or sets whether or not the node is visible on the diagram.
|R/W
| Read/Write
|X
| Yes
|- style="background-color:#CCFFFF;"
| data-sort-value=104173580 |635900C
| [[Node class/Breakpoint Status property|Breakpoint Status]]
| Gets or sets the status of a breakpoint on a node.
| Read/Write
| No
|}
|}
</div>
</div></div>


==Methods==
== Methods ==
<span class="mw-customtoggle-methodstable">Show/Hide Node Methods Table</span>
<span class="mw-customtoggle-methodstable">Show/Hide Node 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"
|+ Node Methods Table
|+ Node 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;"  
|6358C00
| data-sort-value=104172544 |6358C00
| [[Node class/Connect Wires method|Connect Wires]]
| [[Node class/Connect Wires method|Connect Wires]]
|Connects wires to the node. The wire source can be either another node or a terminal. Auto wire applies only if the source is a node. If auto wire is TRUE, compatible terminals are chosen automatically from the source node to be wired to the terminals of the node. Wiring specs is a 2D array of strings that specify  the names of the source and sink terminal pairs.
| Connects wires to the node. The wire source can be either another node or a terminal. Auto wire applies only if the source is a node. If auto wire is TRUE, compatible terminals are chosen automatically from the source node to be wired to the terminals of the node. Wiring specs is a 2D array of strings that specify  the names of the source and sink terminal pairs.
|
| No
|- style="background-color:#CCFFFF;"
|- style="background-color:#CCFFFF;"  
|6358C01
| data-sort-value=104172545 |6358C01
| [[Node class/Get Image method|Get Image]]
| [[Node class/Get Image method|Get Image]]
|Returns an image of a block diagram node.
| Returns an image of a block diagram node.
|
| No
|}
|}
</div>
</div></div>
 
== Event ==
''This class has no events or it inherits events from its parent: [[GObject class#Events|GObject Class]].''


==Events==
''No Events for this 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.
| In [[LabVIEW 2020]] the [[Node class/Visible property|Visible property]] was changed from [[VI Server#Private|Private]] to [[VI Server#VI Scripting|VI Scripting]].
|}
|}


Line 134: Line 142:
*[[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:09, 15 June 2020

VI Server Class Information
Return to VI Server Class Hierarchy
Class Name Node class
Class ID 16421
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 Node class is a class in the VI Server Class Hierarchy, (see also VI Server).

Properties

Show/Hide Node Properties Table

Legend
R/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
Node Properties Table
Property ID Long Name (English) Description R/W RTE
6359000 Terminals[] Array of references to the terminals of the node. To locate a specific terminal reference within the array, use the terminal index displayed in the Context Help window for the node. Read Only No
6359001 Label Returns a reference to the label of the node. You must display the label at least once before this property can return the text of the label. Read Only No
6359002 Description Gets or sets the description of the node. Read/Write No
6359003 Is Break Point Set Read/Write No
6359004 Clump Num Read Only No
6359005 Short Count Read Only No
6359006 Fire Count Read Only No
6359007 Is Asynchronous Read Only No
6359008 Icon Returns the icon for the node. For structure nodes, this property returns the 32 x 32 pixel icon seen on the palettes. Read Only No
6359009 Style Returns the type of node. Read Only No
635900A Is Run At Any Loop Read Only Yes
635900B Visible Gets or sets whether or not the node is visible on the diagram. Read/Write Yes
635900C Breakpoint Status Gets or sets the status of a breakpoint on a node. Read/Write No

Methods

Show/Hide Node Methods Table

Legend
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
Node Methods Table
Property ID Long Name (English) Description RTE
6358C00 Connect Wires Connects wires to the node. The wire source can be either another node or a terminal. Auto wire applies only if the source is a node. If auto wire is TRUE, compatible terminals are chosen automatically from the source node to be wired to the terminals of the node. Wiring specs is a 2D array of strings that specify the names of the source and sink terminal pairs. No
6358C01 Get Image Returns an image of a block diagram node. No

Event

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


History

Version Change(s)
LabVIEW 2020 In LabVIEW 2020 the Visible property was changed from Private to VI Scripting.

See Also

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