IPCB_PowerPlaneConnectStyleRule interface
A power plane connect style rule (TRuleKind.eRule_PowerPlaneConnectStyle) that defines how pads and vias connect to power planes.
public interface IPCB_PowerPlaneConnectStyleRule : IPCB_Rule
Namespace: PCB · Assembly: Altium.SDK.Interfaces
Inherits: IPCB_Primitive → IPCB_Rule
Remarks
The connection is a thermal relief connection, a direct connection (solid copper) or no connection; see PlaneConnectStyle. The relief expansion, the conductor width, the air gap and the number of conductors describe a thermal relief connection; a direct connection does not use them.
A rule can hold separate settings for pads and for vias, and a plane uses the settings for the kind of each pad or via. The properties of this interface read the settings for pads. Assigning a property gives pads and vias the same settings: those of pads with the new value.
A new rule has a thermal relief connection with a relief expansion of 20 mil, conductors 10 mil wide, an air gap of 10 mil and 4 conductors.
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| PlaneConnectStyle | TPlaneConnectStyle | get; set | The style of the connection between a pad or via and the power plane. |
| ReliefAirGap | int | set | The width of the air gap of a thermal relief connection, in internal units (10,000 per mil). |
| ReliefAirGap_1 | int | get | The width of the air gap of a thermal relief connection, in internal units (10,000 per mil). |
| ReliefConductorWidth | int | set | The width of each conductor of a thermal relief connection, in internal units (10,000 per mil). |
| ReliefConductorWidth_1 | int | get | The width of each conductor of a thermal relief connection, in internal units (10,000 per mil). |
| ReliefEntries | int | set | The number of conductors of a thermal relief connection. |
| ReliefEntries_1 | int | get | The number of conductors of a thermal relief connection. |
| ReliefExpansion | int | get; set | The distance between the edge of the hole of a pad or via and the inner edge of the air gap of a thermal relief connection, in internal units (10,000 per mil). |
PlaneConnectStyle
The style of the connection between a pad or via and the power plane.
TPlaneConnectStyle GetState_PlaneConnectStyle();
void SetState_PlaneConnectStyle(TPlaneConnectStyle argValue);
Type: TPlaneConnectStyle · Access: read/write
The accessors are extension methods of IPCB_PowerPlaneConnectStyleRuleHelper (using PCB;).
TPlaneConnectStyle.eReliefConnectToPlane is a thermal relief connection, TPlaneConnectStyle.eDirectConnectToPlane a connection with solid copper, and TPlaneConnectStyle.eNoConnect no connection. A new rule has a thermal relief connection.
ReliefAirGap
The width of the air gap of a thermal relief connection, in internal units (10,000 per mil).
void SetState_ReliefAirGap(int argValue);
Type: int · Access: write-only
Write-only; ReliefAirGap_1 reads the value.
ReliefAirGap_1
The width of the air gap of a thermal relief connection, in internal units (10,000 per mil).
int GetState_ReliefAirGap_1();
Type: int · Access: read-only
Read-only; ReliefAirGap assigns the value. A new rule has 10 mil.
ReliefConductorWidth
The width of each conductor of a thermal relief connection, in internal units (10,000 per mil).
void SetState_ReliefConductorWidth(int argValue);
Type: int · Access: write-only
Write-only; ReliefConductorWidth_1 reads the value.
ReliefConductorWidth_1
The width of each conductor of a thermal relief connection, in internal units (10,000 per mil).
int GetState_ReliefConductorWidth_1();
Type: int · Access: read-only
Read-only; ReliefConductorWidth assigns the value. A new rule has 10 mil.
ReliefEntries
The number of conductors of a thermal relief connection.
void SetState_ReliefEntries(int argValue);
Type: int · Access: write-only
Write-only; ReliefEntries_1 reads the value.
ReliefEntries_1
The number of conductors of a thermal relief connection.
int GetState_ReliefEntries_1();
Type: int · Access: read-only
Read-only; ReliefEntries assigns the value. A new rule has 4.
ReliefExpansion
The distance between the edge of the hole of a pad or via and the inner edge of the air gap of a thermal relief connection, in internal units (10,000 per mil).
int GetState_ReliefExpansion();
void SetState_ReliefExpansion(int argValue);
Type: int · Access: read/write
A new rule has 20 mil.
Inherited members
- From IPCB_Rule: ActualCheck, ActualCheck_1, CheckBinaryScope, CheckUnaryScope, CollisionExpansion, Comment, DataSummaryString, DefinedByLogicalDocument, DRCEnabled, Export_ToParameters_1, GetWhatsThisHelpString, IsUnary, LayerKind, Name, NetScope, NetScopeMatches, Priority, RuleKind, Scope1Expression, Scope1Includes, Scope2Expression, Scope2Includes, ScopeDescriptorString, ScopeKindIsValid, ShortDescriptorString, ViolationDescriptorString
- 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, Replicate, RequiredParamterSpace, RotateBy, Selected, SolderMaskExpansion, SwapLayerPairs, TearDrop, UnionIndex, UniqueId, UniqueID, Used, UserRouted, V7Layer, ViewableObjectID