Wire class
| 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).
Contents |
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 | |
| Property ID | Long Name (English) | Description | R/W | RTE |
|---|---|---|---|---|
| 6371000 | Breakpoint? (Deprecated) | Read/Write | No | |
| 6371001 | Probe | References the probe associated with this wire. | Read Only | No |
| 6371002 | Description | Sets or returns a description of the wire. | Read/Write | No |
| 6371003 | Terminals[] | References the terminals connected by this wire. | Read Only | No |
| 6371004 | Is Broken? | Returns TRUE if the wire is broken or in a bad state. | Read Only | No |
| 6371005 | Joints[] | Returns an array of all joints of the wire, which includes intersections, bends, and end points. | Read Only | Yes |
| 6371006 | Wire Width | Returns the width of the wire in pixels. | Read Only | Yes |
| 6371007 | Is Break Point Set | Read/Write | No | |
| 6371008 | Source Addressing Mode | Read Only | Yes | |
| 6371009 | Data Offset | Read Only | Yes | |
| 637100A | Is Hidden | Read Only | No | |
| 637100B | Breakpoint Status | Reads or writes the status of a breakpoint on a wire. | Read/Write | No |
| 637100C | Signal State | Read Only | No | |
| 637100D | Label | Returns a reference to the label associated with this wire. | Read Only | No |
| 637100E | Value | Read Only | No |
Methods
Show/Hide Wire Properties Table
| Legend | |
|---|---|
| RTE | Available in the Run-Time Engine |
| Basic Development Environment | |
| VI Scripting | |
| Private | |
| Deprecated | |
| Method ID | Long Name (English) | Description | RTE |
|---|---|---|---|
| 6370C00 | Attach Probe | Attaches a probe to the wire and returns a VI reference to the probe. | No |
| 6370C01 | Remove Probe | Removes any probe attached to the wire. | No |
| 6370C02 | Create Constant (Not Implemented) | No | |
| 6370C03 | Create Control (Not Implemented) | No | |
| 6370C04 | Create Indicator (Not Implemented) | No | |
| 6370C05 | Clean Up Wire | Cleans up the wire so that it has no loose ends, no hidden wire, and few bends and branches. | Yes (Read/Write) |
| 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. | No |
| 6370C07 | Copy Probes To Companion | Copies the probes from the simulation diagram to the companion diagram. This method only works if the companion diagram has been scripted. | Yes (Read/Write) |
| 6370C08 | Remove Loose Ends | Removes the loose ends of a wire. | Yes (Read/Write) |
| 6370C09 | Insert Node By Ref (Not Implemented) | No | |
| 6370C0A | Get Error List | Yes | |
| 6370C0B | Delete Joint | Removes the joint closest to Point. | Yes (Read/Write) |
| 6370C0C | Attach Sampling Probe | No | |
| 6370C0D | Disconnect Terminal | No |
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) |
|---|---|
|
More info to come. |