Wire class

VI Server Class Information
Return to VI Server Class Hierarchy
Class Name	Wire class
Class ID	16439
Scope	VI Scripting
Class Inheritance	Generic GObject Wire
Class Children	This class has no children.

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

Properties

Show/Hide Wire Properties Table

Legend
R/W	Readable/Writable Permissions
RTE	Available in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated

Wire Properties Table

Property ID	Short Name (English)	Description	R/W	RTE
637100B	BreakPtStatus	Reads or writes the status of a breakpoint on a wire. Select from Cleared Break, Enabled Break, and Disabled Break.	R/W
6371009	DataOffset		R	X
6371002	Desc	Sets or returns a description of the wire.	R/W
6371004	Broken?	Returns TRUE if the wire is broken or in a bad state.	R
637100A	IsHidden		R
6371005	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. Elements: Name Description Position Identifies the X,Y position of the joint on the block diagram. 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. Up Joint Index Identifies the next index of the array above the joint. Down Joint Index Identifies the next index of the array below the joint. Left Joint Index Identifies the next index of the array to the left of the joint. Right Joint Index Identifies the next index of the array to the right of the joint. Flags Indicates the action of the joint: 0x1—The joint connects to one of the terminals of the signal. 0x2—The joint optimizes the redrawing of signals. Do not modify. 0x4—The joint optimizes the redrawing of signals. Do not modify. 0x8—The joint is currently selected on the block diagram. Any edge LabVIEW selects to be connected to the joint is set. 0x10—LabVIEW selects the right edge of the joint. 0x20—LabVIEW selects the lower edge of the joint. 0x40—LabVIEW uses the joint to optimize routing. Do not modify. 0x8—LabVIEW uses the joint to optimize routing. Do not modify. 0x100—The joint is loose and it is not between two joints that are connected to terminals. Do not modify. 0x200—The joint is on the path. LabVIEW uses this joint during path and split algorithms. Do not modify. 0x400—LabVIEW does not use the joint. 0x800—LabVIEW does not use the joint. 0x1000—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—LabVIEW shifted the joint vertically during the most recent edit operation.	R	X
637100D	Label	Returns a reference to the label associated with this wire.	R
6371001	Probe	References the probe associated with this wire.	R
637100C	SignalState		R
6371008	SrcMode		R	X
6371003	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
637100E	Value		R
6371006	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

Methods

Show/Hide Wire Methods Table

Legend
RTE	Available in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated

Wire Methods Table

Method ID	Short Name (English)	Description	RTE
6370C00	AttachProbe	Attaches a probe to the wire and returns a VI reference to the probe.
6370C0C	AttachSmplingProbe
6370C05	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
6370C07	CopyProbesToCompanion	Copies the probes from the simulation diagram to the companion diagram. This method only works if the companion diagram has been scripted.	X
6370C02	Create Constant
6370C03	Create Control
6370C04	Create Indicator
6370C0B	DeleteJoint	Removes the joint closest to Point.	X
6370C0D	DisconnectTerminal
6370C0A	GetErrorList		X
6370C06	Insert Node	Inserts 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.
6370C09	Insert Node By Ref
6370C08	RemoveLooseEnds	Removes the loose ends of a wire.	X
6370C01	Remove Probe	Removes any probe attached to the wire.

Events

No Events for this class.

History

Version	Change(s)
	More info to come.

See Also

• VI Server Class Hierarchy
• VI Server
• VI Scripting