Jump to content

SharedVariableNode class: Difference between revisions

From LabVIEW Wiki
VisualWikitext
Started page
 
m Removed VI Server Category from page
 
(3 intermediate revisions by the same user not shown)
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 SharedVariableNode Properties Table</span>
{{VIServerClassTables|16512}}
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{| class="wikitable sortable"
|+ SharedVariableNode Properties Table
! Property ID
! Short Name (English)
! Description
! R/W
! RTE
|- style="background-color:#CCFFFF;"
|55D4B00D
| [[SharedVariableNode class/AllowAbsolute? property|AllowAbsolute?]]
|Returns whether you can set the Shared Variable node to an absolute connection with the variable.
|R
|
|- style="background-color:#CCFFFF;"
|55D4B00E
| [[SharedVariableNode class/AllowDirect? property|AllowDirect?]]
|Returns whether you can set the Shared Variable node to use direct access.
|R
|
|- style="background-color:#CCFFFF;"
|55D4B00A
| [[SharedVariableNode class/AllowRead? property|AllowRead?]]
|Returns whether you can read data from variable bound to the Shared Variable node.
|R
|
|- style="background-color:#CCFFFF;"
|55D4B00C
| [[SharedVariableNode class/AllowRelative? property|AllowRelative?]]
|Returns whether you can set the Shared Variable node to a target-relative connection with the variable.
|R
|
|- style="background-color:#CCFFFF;"
|55D4B00F
| [[SharedVariableNode class/AllowScanned? property|AllowScanned?]]
|Returns whether you can set the Shared Variable node to use scanned access.
|R
|
|- style="background-color:#CCFFFF;"
|55D4B00B
| [[SharedVariableNode class/AllowWrite? property|AllowWrite?]]
|Returns whether you can write data to the variable bound to the Shared Variable node.
|R
|
|- style="background-color:#D1BB80;"
|55D4B003
| [[SharedVariableNode class/CustomRule property|CustomRule]]
|
|R/W
|
|- style="background-color:#D1BB80;"
|55D4B012
| [[SharedVariableNode class/GetVRTILOErrors property|GetVRTILOErrors]]
|
|R
|X
|- style="background-color:#CCFFFF;"
|55D4B010
| [[SharedVariableNode class/IOVLocalAccessMode property|IOVLocalAccessMode]]
|Gets or sets the access mode of the Shared Variable node.
|R/W
|
|- style="background-color:#CCFFFF;"
|55D4B004
| [[SharedVariableNode class/RelativeMode property|RelativeMode]]
|Gets or sets whether the connection between a shared variable and a Shared Variable node is absolute, target-relative, or the default mode.
|R/W
|
|- style="background-color:#CCFFFF;"
|55D4B000
| [[SharedVariableNode class/ProjectItem property|ProjectItem]]
|Gets or sets a reference to the shared variable in the LabVIEW Project that is associated with a Shared Variable node.  If the VI with the Shared Variable node is not part of a project, or if the shared variable is located in a different project than the VI, LabVIEW returns an error.
|R/W
|
|- style="background-color:#CCFFFF;"
|55D4B005
| [[SharedVariableNode class/ShowTimeout? property|ShowTimeout?]]
|Gets or sets whether LabVIEW shows the <b>ms timeout</b> input and <b>timed out?</b> output on a Shared Variable node.
|R/W
|
|- style="background-color:#CCFFFF;"
|55D4B002
| [[SharedVariableNode class/ShowTimestamp? property|ShowTimestamp?]]
|Gets or sets whether LabVIEW shows the <b>timestamp</b> terminal on a Shared Variable node.
|R/W
|
|- style="background-color:#CCFFFF;"
|55D4B006
| [[SharedVariableNode class/TimeoutAllowed? property|TimeoutAllowed?]]
|Returns whether a Shared Variable node supports a timeout period.
 
You only can enable a timeout period for Shared Variable nodes configured to read data. You cannot enable a timeout period for nodes that access I/O variables locally.
|R
|
|- style="background-color:#CCFFFF;"
|55D4B011
| [[SharedVariableNode class/TimestampAllowed? property|TimestampAllowed?]]
|Returns whether LabVIEW can display a timestamp for a Shared Variable node.
 
Timestamps are supported only by Shared Variable nodes that are configured to read data.
|R
|
|- style="background-color:#CCFFFF;"
|55D4B001
| [[SharedVariableNode class/Write? property|Write?]]
|Gets or sets whether a Shared Variable node is configured to read or write data. TRUE corresponds to writing data, and FALSE corresponds to reading data.
|R/W
|
|}
</div>
 
==Methods==
<span class="mw-customtoggle-methodstable">Show/Hide SharedVariableNode Methods Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-methodstable">
{{VIServerLegend|showrte=TRUE}}
{| class="wikitable sortable"
|+ SharedVariableNode Methods Table
! Method ID
! Short Name (English)
! Description
! RTE
|- style="background-color:#CCFFFF;"
|55D4AC02
| [[SharedVariableNode class/Change to Constant method|Change to Constant]]
|Changes the shared variable node to a constant and returns a reference to the constant. LabVIEW automatically closes the reference to the shared variable node.
|
|- style="background-color:#CCFFFF;"
|55D4AC00
| [[SharedVariableNode class/Change to Control method|Change to Control]]
|Changes the shared variable node to a control and returns a reference to the control. LabVIEW automatically closes the reference to the shared variable node.
|
|- style="background-color:#CCFFFF;"
|55D4AC01
| [[SharedVariableNode class/Change to Indicator method|Change to Indicator]]
|Changes the shared variable node to an indicator and returns a reference to the indicator. LabVIEW automatically closes the reference to the shared variable node.
|
|- style="background-color:#D1BB80;"
|55D4AC03
| [[SharedVariableNode class/CopyLinkageFromVarXNode method|CopyLinkageFromVarXNode]]
|
|
|- style="background-color:#D1BB80;"
|55D4AC04
| [[SharedVariableNode class/MarkVIRelative method|MarkVIRelative]]
|
|
|}
</div>
 
==Events==
''No Events for this class.''


== History ==
== History ==
Line 177: 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:09, 8 May 2020

VI Server Class Information
Return to VI Server Class Hierarchy
Class Name SharedVariableNode class
Class ID 16512
Scope VI Scripting
Class Inheritance
Class Children

This class has no children.


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

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

Properties

Show/Hide SharedVariableNode Properties Table

Legend
R/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
SharedVariableNode Properties Table
Property ID Long Name (English) Description R/W RTE
55D4B000Shared Variable Project ItemGets or sets a reference to the shared variable in the LabVIEW Project that is associated with a Shared Variable node. If the VI with the Shared Variable node is not part of a project, or if the shared variable is located in a different project than the VI, LabVIEW returns an error.Read/WriteNo
55D4B001Write?Gets or sets whether a Shared Variable node is configured to read or write data. TRUE corresponds to writing data, and FALSE corresponds to reading data.Read/WriteNo
55D4B002Show Timestamp?Gets or sets whether LabVIEW shows the timestamp terminal on a Shared Variable node.Read/WriteNo
55D4B003Custom RuleRead/WriteNo
55D4B004Relative ModeGets or sets whether the connection between a shared variable and a Shared Variable node is absolute, target-relative, or the default mode.Read/WriteNo
55D4B005Show Timeout?Gets or sets whether LabVIEW shows the ms timeout input and timed out? output on a Shared Variable node.Read/WriteNo
55D4B006Timeout Allowed?Returns whether a Shared Variable node supports a timeout period.Read OnlyNo
55D4B00AAllow Read?Returns whether you can read data from variable bound to the Shared Variable node.Read OnlyNo
55D4B00BAllow Write?Returns whether you can write data to the variable bound to the Shared Variable node.Read OnlyNo
55D4B00CAllow Relative?Returns whether you can set the Shared Variable node to a target-relative connection with the variable.Read OnlyNo
55D4B00DAllow Absolute?Returns whether you can set the Shared Variable node to an absolute connection with the variable.Read OnlyNo
55D4B00EAllow Direct?Returns whether you can set the Shared Variable node to use direct access.Read OnlyNo
55D4B00FAllow Scanned?Returns whether you can set the Shared Variable node to use scanned access.Read OnlyNo
55D4B010IOVLocalAccessModeGets or sets the access mode of the Shared Variable node.Read/WriteNo
55D4B011Timestamp Allowed?Returns whether LabVIEW can display a timestamp for a Shared Variable node.Read OnlyNo
55D4B012GetVRTILOErrorsRead OnlyYes

Methods

Show/Hide SharedVariableNode Properties Table

Legend
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
SharedVariableNode Methods Table
Method ID Long Name (English) Description RTE
55D4AC00Change to ControlChanges the shared variable node to a control and returns a reference to the control. LabVIEW automatically closes the reference to the shared variable node.No
55D4AC01Change to IndicatorChanges the shared variable node to an indicator and returns a reference to the indicator. LabVIEW automatically closes the reference to the shared variable node.No
55D4AC02Change to ConstantChanges the shared variable node to a constant and returns a reference to the constant. LabVIEW automatically closes the reference to the shared variable node.No
55D4AC03Copy Linkage From VarXNodeNo
55D4AC04MarkVIRelativeNo

Events

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


History

History information is needed. What changes have occurred over previous versions?
Version Change(s)
LabVIEW 2018 More info to come.

See Also

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