Skip to main content
View as Markdown

IPCB_FromTo interface

A from-to on a PCB document, a user-defined connection from one pad of a net to another pad of the same net.

public interface IPCB_FromTo : IPCB_Primitive

Namespace: PCB · Assembly: Altium.SDK.Interfaces

Inherits: IPCB_Primitive

Remarks​

The from-to refers to its net and its pads by name: NetName is the name of the net, and FromPad and ToPad are pin descriptors as returned by IPCB_Pad.PinDescriptorString, that is the component designator, a hyphen and the pad name, or Free- followed by the pad name for a pad that is not part of a component. GetNet, GetFromPad and GetToPad find the objects on the board.

The from-to's Identifier is the net name followed by the two pin descriptors, separated by a colon, in parentheses; DescriptorString returns FromTo : followed by the identifier.

Properties​

PropertyTypeAccessDescription
FromPadstringget; setThe pin descriptor of the pad at the start of the from-to.
NetNamestringget; setThe name of the net the from-to belongs to.
RoutedLengthintgetThe routed length of the from-to, in internal units (10,000 per mil).
ToPadstringget; setThe pin descriptor of the pad at the end of the from-to.

FromPad​

The pin descriptor of the pad at the start of the from-to.

string GetState_FromPad();
void SetState_FromPad(string argValue);

Type: string · Access: read/write

Assigning a value only stores the text; GetFromPad returns the pad it names.

NetName​

The name of the net the from-to belongs to.

string GetState_NetName();
void SetState_NetName(string argValue);

Type: string · Access: read/write

Assigning a value only stores the text; GetNet returns the net it names.

RoutedLength​

The routed length of the from-to, in internal units (10,000 per mil).

int GetState_RoutedLength();

Type: int · Access: read-only

The sum of the lengths of the tracks and arcs on signal layers and the heights of the vias that connect the two pads. These primitives are found when the connectivity of the net is analysed, and only when both pads are found and connected to each other; otherwise the value is 0.

ToPad​

The pin descriptor of the pad at the end of the from-to.

string GetState_ToPad();
void SetState_ToPad(string argValue);

Type: string · Access: read/write

Assigning a value only stores the text; GetToPad returns the pad it names.

Methods​

MethodReturnsDescription
GetFromPadIPCB_PadReturns the pad named by FromPad.
GetNetIPCB_NetReturns the net named by NetName.
GetToPadIPCB_PadReturns the pad named by ToPad.

GetFromPad​

Returns the pad named by FromPad.

IPCB_Pad GetFromPad();

Returns: IPCB_Pad

Extension method of IPCB_FromToHelper (using PCB;).

The pad is looked up among the pads of the net returned by GetNet; its IPCB_Pad.PinDescriptorString must equal FromPad exactly. Returns null when the net or the pad is not found.

GetNet​

Returns the net named by NetName.

IPCB_Net GetNet();

Returns: IPCB_Net

Extension method of IPCB_FromToHelper (using PCB;).

Returns null when the from-to is not on a board or the board has no net of that name.

GetToPad​

Returns the pad named by ToPad.

IPCB_Pad GetToPad();

Returns: IPCB_Pad

Extension method of IPCB_FromToHelper (using PCB;).

The pad is looked up among the pads of the net returned by GetNet; its IPCB_Pad.PinDescriptorString must equal ToPad exactly. Returns null when the net or the pad is not found.

Inherited members​