Jump to content

Wire class: Difference between revisions

From LabVIEW Wiki
Newer edit →
VisualWikitext
Started page
 
Replaced with template tables
Tag: Replaced
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 Wire Properties Table</span>
{{VIServerClassTables|16439}}
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{| class="wikitable sortable"
|+ Wire Properties Table
! Property ID
! Short Name (English)
! Description
! R/W
! RTE
|- style="background-color:#CCFFFF;"
|637100B
| [[Wire class/BreakPtStatus property|BreakPtStatus]]
|Reads or writes the status of a breakpoint on a wire.
 
Select from Cleared Break, Enabled Break, and Disabled Break.
|R/W
|
|- style="background-color:#D1BB80;"
|6371009
| [[Wire class/DataOffset property|DataOffset]]
|
|R
|X
|- style="background-color:#CCFFFF;"
|6371002
| [[Wire class/Desc property|Desc]]
|Sets or returns a description of the wire.
|R/W
|
|- style="background-color:#CCFFFF;"
|6371004
| [[Wire class/Broken? property|Broken?]]
|Returns TRUE if the wire is broken or in a bad state.
|R
|
|- style="background-color:#D1BB80;"
|637100A
| [[Wire class/IsHidden property|IsHidden]]
|
|R
|
|- style="background-color:#CCFFFF;"
|6371005
| [[Wire class/Joints() property|Joints()]]
|Returns an array of all joints of the wire, which includes intersections, bends, and end points.
 
The output of this property is an array of clusters, and each cluster represents one joint of the wire. The following table lists descriptions for the output of each cluster.
 
{| class="wikitable"
|+ scope="col" style="text-align:left;"|Elements:
! scope="col" style="text-align:left;"| Name
! scope="col" style="text-align:left;"| Description
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Position
|Identifies the X,Y position of the joint on the block diagram.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Type
|Indicates whether the joint has a loose end, an endpoint, a bend in the wire, a fork of the wire, or a connection to a terminal.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Up Joint Index
|Identifies the next index of the array above the joint.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Down Joint Index
|Identifies the next index of the array below the joint.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Left Joint Index
|Identifies the next index of the array to the left of the joint.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Right Joint Index
|Identifies the next index of the array to the right of the joint.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Flags
|Indicates the action of the joint:
*0x1&#8212;The joint connects to one of the terminals of the signal.
*0x2&#8212;The joint optimizes the redrawing of signals. Do not modify.
*0x4&#8212;The joint optimizes the redrawing of signals. Do not modify.
*0x8&#8212;The joint is currently selected on the block diagram. Any edge LabVIEW selects to be connected to the joint is set.
*0x10&#8212;LabVIEW selects the right edge of the joint.
*0x20&#8212;LabVIEW selects the lower edge of the joint.
*0x40&#8212;LabVIEW uses the joint to optimize routing. Do not modify.
*0x8&#8212;LabVIEW uses the joint to optimize routing. Do not modify.
*0x100&#8212;The joint is loose and it is not between two joints that are connected to terminals. Do not modify.
*0x200&#8212;The joint is on the path. LabVIEW uses this joint during path and split algorithms. Do not modify.
*0x400&#8212;LabVIEW does not use the joint.
*0x800&#8212;LabVIEW does not use the joint.
*0x1000&#8212;LabVIEW shifted the joint horizontally during the most recent edit operation. The joint clears when the wire table rebuilds at the end of every edit operation.
*0x2000&#8212;LabVIEW shifted the joint vertically during the most recent edit operation.
|}
|R
|X
|- style="background-color:#CCFFFF;"
|637100D
| [[Wire class/Label property|Label]]
|Returns a reference to the label associated with this wire.
|R
|
|- style="background-color:#CCFFFF;"
|6371001
| [[Wire class/Probe property|Probe]]
|References the probe associated with this wire.
|R
|
|- style="background-color:#D1BB80;"
|637100C
| [[Wire class/SignalState property|SignalState]]
|
|R
|
|- style="background-color:#D1BB80;"
|6371008
| [[Wire class/SrcMode property|SrcMode]]
|
|R
|X
|- style="background-color:#CCFFFF;"
|6371003
| [[Wire class/Terms() property|Terms()]]
|References the terminals connected by this wire.
 
The first reference is the source if a source exists. The other references on the list are in no particular order. If there is more than one source on the list, the wire is broken and the extra sources are not necessarily at the start of the list.
|R
|
|- style="background-color:#D1BB80;"
|637100E
| [[Wire class/Value property|Value]]
|
|R
|
|- style="background-color:#CCFFFF;"
|6371006
| [[Wire class/Width property|Width]]
|Returns the width of the wire in pixels.
 
The width measures only the colored portion of the wire and does not include the extra pixel of white border that appears on each side when the wire crosses another wire.
|R
|X
|}
</div>
 
==Methods==
<span class="mw-customtoggle-methodstable">Show/Hide Wire Methods Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-methodstable">
{{VIServerLegend|showrte=TRUE}}
{| class="wikitable sortable"
|+ Wire Methods Table
! Method ID
! Short Name (English)
! Description
! RTE
|- style="background-color:#CCFFFF;"
|6370C00
| [[Wire class/AttachProbe method|AttachProbe]]
|Attaches a probe to the wire and returns a VI reference to the probe.
|
|- style="background-color:#D1BB80;"
|6370C0C
| [[Wire class/AttachSmplingProbe method|AttachSmplingProbe]]
|
|
|- style="background-color:#CCFFFF;"
|6370C05
| [[Wire class/CleanUpWire method|CleanUpWire]]
|Cleans up the wire so that it has no loose ends, no hidden wire, and few bends and branches.
 
The wire you clean up maintains connections to all other terminals.
|X
|- style="background-color:#CCFFFF;"
|6370C07
| [[Wire class/CopyProbesToCompanion method|CopyProbesToCompanion]]
|Copies the probes from the simulation diagram to the companion diagram. This method only works if the companion diagram has been scripted.
|X
|- style="background-color:#D1BB80;"
|6370C02
| [[Wire class/Create Constant method|Create Constant]]
|
|
|- style="background-color:#D1BB80;"
|6370C03
| [[Wire class/Create Control method|Create Control]]
|
|
|- style="background-color:#D1BB80;"
|6370C04
| [[Wire class/Create Indicator method|Create Indicator]]
|
|
|- style="background-color:#CCFFFF;"
|6370C0B
| [[Wire class/DeleteJoint method|DeleteJoint]]
|Removes the joint closest to <b>Point</b>.
|X
|- style="background-color:#CCFFFF;"
|6370C0D
| [[Wire class/DisconnectTerminal method|DisconnectTerminal]]
|
|
|- style="background-color:#D1BB80;"
|6370C0A
| [[Wire class/GetErrorList method|GetErrorList]]
|
|X
|- style="background-color:#CCFFFF;"
|6370C06
| [[Wire class/Insert Node method|Insert Node]]
|Inserts a new node into the wire and returns a reference to the node. Use only <b>Style</b> or <b>Path</b> to specify the new node, not both.
|
|- style="background-color:#D1BB80;"
|6370C09
| [[Wire class/Insert Node By Ref method|Insert Node By Ref]]
|
|
|- style="background-color:#CCFFFF;"
|6370C08
| [[Wire class/RemoveLooseEnds method|RemoveLooseEnds]]
|Removes the loose ends of a wire.
|X
|- style="background-color:#CCFFFF;"
|6370C01
| [[Wire class/Remove Probe method|Remove Probe]]
|Removes any probe attached to the wire.
|
|}
</div>
 
==Events==
''No Events for this class.''


== History ==
== History ==

Revision as of 01:07, 9 September 2019

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

Properties

Show/Hide Wire Properties Table

Legend
R/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
Wire Properties Table
Property ID Long Name (English) Description R/W RTE
6371000Breakpoint? (Deprecated)Read/WriteNo
6371001ProbeReferences the probe associated with this wire.Read OnlyNo
6371002DescriptionSets or returns a description of the wire.Read/WriteNo
6371003Terminals[]References the terminals connected by this wire.Read OnlyNo
6371004Is Broken?Returns TRUE if the wire is broken or in a bad state.Read OnlyNo
6371005Joints[]Returns an array of all joints of the wire, which includes intersections, bends, and end points.Read OnlyYes
6371006Wire WidthReturns the width of the wire in pixels.Read OnlyYes
6371007Is Break Point SetRead/WriteNo
6371008Source Addressing ModeRead OnlyYes
6371009Data OffsetRead OnlyYes
637100AIs HiddenRead OnlyNo
637100BBreakpoint StatusReads or writes the status of a breakpoint on a wire.Read/WriteNo
637100CSignal StateRead OnlyNo
637100DLabelReturns a reference to the label associated with this wire.Read OnlyNo
637100EValueRead OnlyNo

Methods

Show/Hide Wire Properties Table

Legend
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
Wire Methods Table
Method ID Long Name (English) Description RTE
6370C00Attach ProbeAttaches a probe to the wire and returns a VI reference to the probe.No
6370C01Remove ProbeRemoves any probe attached to the wire.No
6370C02Create Constant (Not Implemented)No
6370C03Create Control (Not Implemented)No
6370C04Create Indicator (Not Implemented)No
6370C05Clean Up WireCleans up the wire so that it has no loose ends, no hidden wire, and few bends and branches.Yes (Read/Write)
6370C06Insert NodeInserts a new node into the wire and returns a reference to the node. Use only Style or Path to specify the new node, not both.No
6370C07Copy Probes To CompanionCopies the probes from the simulation diagram to the companion diagram. This method only works if the companion diagram has been scripted.Yes (Read/Write)
6370C08Remove Loose EndsRemoves the loose ends of a wire.Yes (Read/Write)
6370C09Insert Node By Ref (Not Implemented)No
6370C0AGet Error ListYes
6370C0BDelete JointRemoves the joint closest to Point.Yes (Read/Write)
6370C0CAttach Sampling ProbeNo
6370C0DDisconnect TerminalNo

Events

This class has no events or it inherits events from its parent: GObject 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=Wire_class&oldid=9932"