Jump to content

Wire class

From LabVIEW Wiki
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.


    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

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

    See Also