IPCB_LayerStack interface
A layer stack of a board, such as the one IPCB_Board.LayerStack returns or a substack of the board's IPCB_MasterLayerStack.
public interface IPCB_LayerStack : IPCB_LayerStackBase
Namespace: PCB · Assembly: Altium.SDK.Interfaces
Inherits: IPCB_LayerStackBase
Remarks
Walk its layers with the members inherited from IPCB_LayerStackBase, such as IPCB_LayerStackBase.Iterator, IPCB_LayerStackBase.First and IPCB_LayerStackBase.Next. The layer walk with FirstLayer and NextLayer belongs to IPCB_LayerStack_V7, which IPCB_Board.LayerStack_V7 returns.
Each kind of layer has its own interface derived from IPCB_LayerObject, such as IPCB_SignalLayer, IPCB_InternalPlane, IPCB_DielectricLayer and IPCB_SolderMaskLayer.
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| BottomSignalLayer | V7_LayerBase | get | The layer ID of the last electrical layer of the layer stack that is not a coverlay layer. |
| ShowBotDielectric | bool | get; set | |
| ShowTopDielectric | bool | get; set | |
| TopSignalLayer | V7_LayerBase | get | The layer ID of the first electrical layer of the layer stack that is not a coverlay layer. |
BottomSignalLayer
The layer ID of the last electrical layer of the layer stack that is not a coverlay layer.
V7_LayerBase GetState_BottomSignalLayer();
Type: V7_LayerBase · Access: read-only
The accessors are extension methods of IPCB_LayerStackHelper (using PCB;).
It is the bottom layer when the stack has no such layer.
ShowBotDielectric
No description yet.
bool GetState_ShowBotDielectric();
void SetState_ShowBotDielectric(bool argValue);
Type: bool · Access: read/write
The value is a stored flag of the layer stack; setting it changes only the flag.
ShowTopDielectric
No description yet.
bool GetState_ShowTopDielectric();
void SetState_ShowTopDielectric(bool argValue);
Type: bool · Access: read/write
The value is a stored flag of the layer stack; setting it changes only the flag.
TopSignalLayer
The layer ID of the first electrical layer of the layer stack that is not a coverlay layer.
V7_LayerBase GetState_TopSignalLayer();
Type: V7_LayerBase · Access: read-only
The accessors are extension methods of IPCB_LayerStackHelper (using PCB;).
It is the top layer when the stack has no such layer.
Methods
| Method | Returns | Description |
|---|---|---|
| Board | IPCB_Board | Returns the board that owns the layer stack, or null when there is none. |
| DielectricBottom | IPCB_SolderMaskLayer | Returns the bottom solder mask layer of the layer stack, or null when the stack has none. |
| DielectricTop | IPCB_SolderMaskLayer | Returns the top solder mask layer of the layer stack, or null when the stack has none. |
| LayerObject | IPCB_LayerObject | Returns the layer object of the given layer. |
| LayerObject_1 | IPCB_LayerObject | Returns the layer object of the given layer. |
Board
Returns the board that owns the layer stack, or null when there is none.
IPCB_Board Board();
Returns: IPCB_Board
Extension method of IPCB_LayerStackHelper (using PCB;).
See also: IPCB_Board
DielectricBottom
Returns the bottom solder mask layer of the layer stack, or null when the stack has none.
IPCB_SolderMaskLayer DielectricBottom();
Returns: IPCB_SolderMaskLayer
Extension method of IPCB_LayerStackHelper (using PCB;).
See also: IPCB_SolderMaskLayer
DielectricTop
Returns the top solder mask layer of the layer stack, or null when the stack has none.
IPCB_SolderMaskLayer DielectricTop();
Returns: IPCB_SolderMaskLayer
Extension method of IPCB_LayerStackHelper (using PCB;).
See also: IPCB_SolderMaskLayer
LayerObject
Returns the layer object of the given layer.
IPCB_LayerObject LayerObject(TV6_Layer argLayer);
| Parameter | Type | Passing | Description |
|---|---|---|---|
argLayer | TV6_Layer | value | The layer, from TV6_Layer.eV6_TopLayer to TV6_Layer.eV6_ViaHoleLayer; any other value returns null. |
Returns: IPCB_LayerObject
Extension method of IPCB_LayerStackHelper (using PCB;).
For a layer that is not in the layer stack it returns the master layer stack's layer object with that layer ID, created when needed. So it also returns a layer object for a layer that is not in the stack, such as a keep-out layer or a mechanical layer.
See also: IPCB_LayerObject
LayerObject_1
Returns the layer object of the given layer.
IPCB_LayerObject LayerObject_1(V7_LayerBase argLayer);
| Parameter | Type | Passing |
|---|---|---|
argLayer | V7_LayerBase | value |
Returns: IPCB_LayerObject
Extension method of IPCB_LayerStackHelper (using PCB;).
For a layer that is not in the layer stack it returns the master layer stack's layer object with that layer ID, created when needed. So it also returns a layer object for a layer that is not in the stack, such as a keep-out layer or a mechanical layer.
See also: IPCB_LayerObject
Inherited members
- From IPCB_LayerStackBase: Count, Count_1, Count_2, First, ID, IsFlex, Iterator, Iterator_1, Iterator_2, Last, Name, Next, Previous, StateID, ZBottom, ZTop
Returned by
IPCB_Board.LayerStack, IPCB_BoardEx2.GetLayerStackAtPoint, IPCB_BoardEx2.GetLayerStackForPrimitive, IPCB_BoardRegion.LayerStack, IPCB_MasterLayerStack.CreateSubstack, IPCB_MasterLayerStack.GetSubstack, IPCB_MasterLayerStack.GetSubstack_1, IPCB_MasterLayerStack.Substacks, IPCB_MasterLayerStack2.CreateSubstackWithId, IPCB_StackObject.GetLayerStack, IPCB_TraceImpedance.SubStack
Accepted by
IPCB_ImpedanceProfile.CreateTraceImpedance, IPCB_ImpedanceProfile.GetTraceImpedanceForLayer, IPCB_MasterLayerStack.DisableLayer, IPCB_MasterLayerStack.EnableLayer, IPCB_MasterLayerStack.RemoveSubstack, IPCB_MasterLayerStack2.ChangeSubStackId