Jump to content

Terminal class: Difference between revisions

From LabVIEW Wiki
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 Terminal Properties Table</span>
{{VIServerClassTables|16385}}
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{| class="wikitable sortable"
|+ Terminal Properties Table
! Property ID
! Short Name (English)
! Description
! R/W
! RTE
|- style="background-color:#CCFFFF;"
|634A005
| [[Terminal class/Caption property|Caption]]
|Returns the caption for the terminal. The caption is the translatable string.
|R
|
|- style="background-color:#CCFFFF;"
|634A006
| [[Terminal class/Coerced? property|Coerced?]]
|Returns a value of True  if a coercion dot is present on the terminal.
|R
|
|- style="background-color:#CCFFFF;"
|634A000
| [[Terminal class/Wire property|Wire]]
|Reference to the connected wire.
|R
|
|- style="background-color:#CCFFFF;"
|634A008
| [[Terminal class/Data Type property|Data Type]]
|Returns the data type of the terminal as a Variant.
|R
|
|- style="background-color:#CCFFFF;"
|634A002
| [[Terminal class/Diagram property|Diagram]]
|Returns a reference to the owning diagram.
|R
|
|- style="background-color:#D1BB80;"
|634A00A
| [[Terminal class/HasBuff property|HasBuff]]
|
|R
|X
|- style="background-color:#CCFFFF;"
|634A009
| [[Terminal class/IsHidden property|IsHidden]]
|Returns a value of True if the terminal hidden and a False if the terminal is not hidden.
|R
|
|- style="background-color:#CCFFFF;"
|634A003
| [[Terminal class/IsSource property|IsSource]]
|Provides a True value if the terminal is a source and a False value if the terminal is a sink.
|R
|
|- style="background-color:#CCFFFF;"
|634A004
| [[Terminal class/Name property|Name]]
|Returns the name of the terminal. The name is the non-translatable string identifier.
|R
|
|}
</div>
 
==Methods==
<span class="mw-customtoggle-methodstable">Show/Hide Terminal Methods Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-methodstable">
{{VIServerLegend|showrte=TRUE}}
{| class="wikitable sortable"
|+ Terminal Methods Table
! Method ID
! Short Name (English)
! Description
! RTE
|- style="background-color:#CCFFFF;"
|6349C03
| [[Terminal class/Connect Wire method|Connect Wire]]
|Connects a wire to the terminal. The wire source can be either another terminal or a node.
|
|- style="background-color:#CCFFFF;"
|6349C00
| [[Terminal class/Create Constant method|Create Constant]]
|Creates a constant for the terminal and returns a reference to it. You can specify an optional value for the constant.
|
|- style="background-color:#CCFFFF;"
|6349C01
| [[Terminal class/Create Control method|Create Control]]
|Creates a control for the terminal and returns a reference to it. You can specify an optional value for the control.
|
|- style="background-color:#CCFFFF;"
|6349C04
| [[Terminal class/Create Described Wire method|Create Described Wire]]
|Connects a wire to the terminal. The wire source can only be another terminal.
|
|- style="background-color:#CCFFFF;"
|6349C02
| [[Terminal class/Create Indicator method|Create Indicator]]
|Creates an indicator for the terminal and returns a reference to it. You can specify an optional value for the indicator.
|
|- style="background-color:#CCFFFF;"
|6349C05
| [[Terminal class/Create Shared Variable Node method|Create Shared Variable Node]]
|Creates a shared variable node from the terminal and returns a reference to the shared variable node. You can link the project item of a variable to the new shared variable node.
|
|}
</div>
 
==Events==
''No Events for this class.''


== History ==
== History ==
Line 136: 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 01:53, 8 May 2020

VI Server Class Information
Return to VI Server Class Hierarchy
Class Name Terminal class
Class ID 16385
Scope VI Scripting
Class Inheritance
Class Children


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

Properties

Show/Hide Terminal Properties Table

Legend
R/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
Terminal Properties Table
Property ID Long Name (English) Description R/W RTE
634A000Connected WireReference to the connected wire.Read OnlyNo
634A001Type DescriptorRead OnlyNo
634A002DiagramReturns a reference to the owning diagram.Read OnlyNo
634A003Is Source?Provides a True value if the terminal is a source and a False value if the terminal is a sink.Read OnlyNo
634A004NameReturns the name of the terminal. The name is the non-translatable string identifier.Read OnlyNo
634A005CaptionReturns the caption for the terminal. The caption is the translatable string.Read OnlyNo
634A006Coercion Dot?Returns a value of True if a coercion dot is present on the terminal.Read OnlyNo
634A007Type Descriptor (Full)Read OnlyNo
634A008Data TypeReturns the data type of the terminal as a Variant.Read OnlyNo
634A009Is Hidden?Returns a value of True if the terminal hidden and a False if the terminal is not hidden.Read OnlyNo
634A00AHas Buffer AllocationRead OnlyYes

Methods

Show/Hide Terminal Properties Table

Legend
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
Terminal Methods Table
Method ID Long Name (English) Description RTE
6349C00Create ConstantCreates a constant for the terminal and returns a reference to it. You can specify an optional value for the constant.No
6349C01Create ControlCreates a control for the terminal and returns a reference to it. You can specify an optional value for the control.No
6349C02Create IndicatorCreates an indicator for the terminal and returns a reference to it. You can specify an optional value for the indicator.No
6349C03Connect WireConnects a wire to the terminal. The wire source can be either another terminal or a node.No
6349C04Create Described WireConnects a wire to the terminal. The wire source can only be another terminal.No
6349C05Create Shared Variable NodeCreates a shared variable node from the terminal and returns a reference to the shared variable node. You can link the project item of a variable to the new shared variable node.No

Events

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


History

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

See Also