IPCB_DifferentialPair interface
A differential pair on a PCB document, a named pair of nets, a positive and a negative net, that carry a signal and its equal but opposite image.
public interface IPCB_DifferentialPair : IPCB_Primitive
Namespace: PCB · Assembly: Altium.SDK.Interfaces
Inherits: IPCB_Primitive
Remarks
The pair refers to its nets by name and finds them on the board when PositiveNet or NegativeNet is read. A net that is assigned to or found by the pair belongs to it: its IPCB_Net.InDifferentialPair is true. When the pair is removed from the board, its nets no longer belong to a differential pair.
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| GatherControl | bool | get; set | |
| Name | string | get; set | The name of the differential pair. |
| NegativeNet | IPCB_Net | get; set | The negative net of the pair. |
| PositiveNet | IPCB_Net | get; set | The positive net of the pair. |
GatherControl
No description yet.
bool GetState_GatherControl();
void SetState_GatherControl(bool argValue);
Type: bool · Access: read/write
A new differential pair has false.
Name
The name of the differential pair.
string GetState_Name();
void SetState_Name(string argValue);
Type: string · Access: read/write
The name is also the pair's Identifier; DescriptorString returns Differential Pair followed by a space and the name.
NegativeNet
The negative net of the pair.
IPCB_Net GetState_NegativeNet();
void SetState_NegativeNet(IPCB_Net argValue);
Type: IPCB_Net · Access: read/write
The accessors are extension methods of IPCB_DifferentialPairHelper (using PCB;).
Assigning a net stores its name and makes the net part of the pair; assigning null clears the stored name. When the pair has a stored name but no net, for example after the document is loaded, reading the property looks up the net with that name on the board; the result is null when no net has that name.
PositiveNet
The positive net of the pair.
IPCB_Net GetState_PositiveNet();
void SetState_PositiveNet(IPCB_Net argValue);
Type: IPCB_Net · Access: read/write
The accessors are extension methods of IPCB_DifferentialPairHelper (using PCB;).
Assigning a net stores its name and makes the net part of the pair; assigning null clears the stored name. When the pair has a stored name but no net, for example after the document is loaded, reading the property looks up the net with that name on the board; the result is null when no net has that name.
Inherited members
- From IPCB_Primitive: AllowGlobalEdit, BeginModify, Board, BoundingRectangle, BoundingRectangleChildren, BoundingRectangleForPainting, BoundingRectangleForSelection, CancelModify, Component, Coordinate, DescriptorString, DetailString, Dimension, DrawAsPreview, DRCError, Enabled, Enabled_Direct, Enabled_vComponent, Enabled_vCoordinate, Enabled_vDimension, Enabled_vNet, Enabled_vPolygon, EnableDraw, EndModify, Export_ToParameters, FlipXY, GraphicallyInvalidate, Handle, Identifier, InBoard, InComponent, InCoordinate, Index, InDimension, InNet, InPolygon, InSelectionMemory, IsAssyTestPoint_Bottom, IsAssyTestPoint_Top, IsElectricalPrim, IsFreePrimitive, IsHidden, IsKeepout, IsPreRoute, IsSaveable, IsTenting, IsTenting_Bottom, IsTenting_Top, IsTestPoint_Bottom, IsTestPoint_Top, Layer, MiscFlag1, MiscFlag2, MiscFlag3, Moveable, MoveByXY, MoveToXY, Net, ObjectID, ObjectIDString, PadCacheRobotFlag, PasteMaskExpansion, Polygon, PolygonOutline, PowerPlaneClearance, PowerPlaneConnectStyle, PowerPlaneReliefExpansion, Preview, ReliefAirGap, ReliefConductorWidth, ReliefEntries, Replicate, RequiredParamterSpace, RotateBy, Selected, SolderMaskExpansion, SwapLayerPairs, TearDrop, UnionIndex, UniqueId, UniqueID, Used, UserRouted, V7Layer, ViewableObjectID