IPCB_OutputOptions interface
The output settings of a PCB document, such as drill drawing symbols, pad master layers and the plotted layers, returned by IPCB_Board.OutputOptions.
public interface IPCB_OutputOptions : IPCB_AbstractOptions
Namespace: PCB · Assembly: Altium.SDK.Interfaces
Inherits: IPCB_AbstractOptions
Remarks
The interface extends IPCB_AbstractOptions. The settings form two groups: general options (drill symbols, pad master layers, vias in the solder mask and unconnected pads) and layer options (PlotLayer, FlipLayer and the inclusion of mechanical layers with all plots). Each group can be written to and read from a parameter string.
Export_ToParameters writes every setting as a parameter; Import_FromParameters reads them. Both handle the two groups; Import_FromParameters_Version3 and Export_ToParameters_Version3 handle the general options and the layer options in the version 3 layer numbering.
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| BottomLayerOnPadMaster | bool | get; set | |
| DrillDrawSymbolSize | int | get; set | The size of the symbols on the drill drawing, in internal units (10,000 per mil). |
| DrillGuideHoleSize | int | get; set | The hole size used on the drill guide, in internal units (10,000 per mil). |
| DrillSymbolKind | TDrillSymbol | get; set | How hole sizes are marked on the drill drawing, with graphic symbols (TDrillSymbol.eSymbols), numbers (TDrillSymbol.eNumbers) or letters (TDrillSymbol.eLetters). |
| FlipLayer | bool | get; set | |
| IncludeUnconnectedPads | bool | get; set | |
| IncludeViasInSolderMask | bool | get; set | |
| MultiLayerOnPadMaster | bool | get; set | |
| PlotLayer | bool | get; set | |
| TopLayerOnPadMaster | bool | get; set |
BottomLayerOnPadMaster
No description yet.
bool GetState_BottomLayerOnPadMaster();
void SetState_BottomLayerOnPadMaster(bool argValue);
Type: bool · Access: read/write
Newly created options start with true.
DrillDrawSymbolSize
The size of the symbols on the drill drawing, in internal units (10,000 per mil).
int GetState_DrillDrawSymbolSize();
void SetState_DrillDrawSymbolSize(int argValue);
Type: int · Access: read/write
Newly created options start with 50 mil.
DrillGuideHoleSize
The hole size used on the drill guide, in internal units (10,000 per mil).
int GetState_DrillGuideHoleSize();
void SetState_DrillGuideHoleSize(int argValue);
Type: int · Access: read/write
Newly created options start with 30 mil.
DrillSymbolKind
How hole sizes are marked on the drill drawing, with graphic symbols (TDrillSymbol.eSymbols), numbers (TDrillSymbol.eNumbers) or letters (TDrillSymbol.eLetters).
TDrillSymbol GetState_DrillSymbolKind();
void SetState_DrillSymbolKind(TDrillSymbol argValue);
Type: TDrillSymbol · Access: read/write
The accessors are extension methods of IPCB_OutputOptionsHelper (using PCB;).
Newly created options start with TDrillSymbol.eSymbols.
FlipLayer
No description yet.
bool GetState_FlipLayer(TV6_PlotLayer argPL);
void SetState_FlipLayer(TV6_PlotLayer argPL, bool argValue);
Type: bool · Access: read/write · Index: argPL (TV6_PlotLayer): The plot layer.
The accessors are extension methods of IPCB_OutputOptionsHelper (using PCB;).
IncludeUnconnectedPads
No description yet.
bool GetState_IncludeUnconnectedPads();
void SetState_IncludeUnconnectedPads(bool argValue);
Type: bool · Access: read/write
Newly created options start with true.
IncludeViasInSolderMask
No description yet.
bool GetState_IncludeViasInSolderMask();
void SetState_IncludeViasInSolderMask(bool argValue);
Type: bool · Access: read/write
Newly created options start with true.
MultiLayerOnPadMaster
No description yet.
bool GetState_MultiLayerOnPadMaster();
void SetState_MultiLayerOnPadMaster(bool argValue);
Type: bool · Access: read/write
Newly created options start with true.
PlotLayer
No description yet.
bool GetState_PlotLayer(TV6_PlotLayer argPL);
void SetState_PlotLayer(TV6_PlotLayer argPL, bool argValue);
Type: bool · Access: read/write · Index: argPL (TV6_PlotLayer): The plot layer.
The accessors are extension methods of IPCB_OutputOptionsHelper (using PCB;).
TopLayerOnPadMaster
No description yet.
bool GetState_TopLayerOnPadMaster();
void SetState_TopLayerOnPadMaster(bool argValue);
Type: bool · Access: read/write
Newly created options start with true.
Methods
| Method | Returns | Description |
|---|---|---|
| Export_ToParameters_GeneralOptions | void | Writes the general output settings to a parameter string. |
| Export_ToParameters_LayerOptions | void | Writes the layer settings to a parameter string. |
| Export_ToParameters_LayerOptions_Version3 | void | Writes the layer settings to a parameter string in the version 3 layer numbering. |
| Import_FromParameters_GeneralOptions | void | Reads the general output settings from a parameter string. |
| Import_FromParameters_LayerOptions | void | Reads the layer settings from a parameter string. |
| Import_FromParameters_LayerOptions_Version3 | void | Reads the layer settings from a parameter string that uses the version 3 layer numbering. |
Export_ToParameters_GeneralOptions
Writes the general output settings to a parameter string.
void Export_ToParameters_GeneralOptions(ref string argParameters);
| Parameter | Type | Passing | Description |
|---|---|---|---|
argParameters | string | ref | The parameter string that receives the settings. |
Returns: nothing (void)
Writes DrillGuideHoleSize, DrillDrawSymbolSize, DrillSymbolKind, MultiLayerOnPadMaster, TopLayerOnPadMaster, BottomLayerOnPadMaster, IncludeViasInSolderMask and IncludeUnconnectedPads. The layer settings are not written: use Export_ToParameters_LayerOptions.
Export_ToParameters_LayerOptions
Writes the layer settings to a parameter string.
void Export_ToParameters_LayerOptions(ref string argParameters);
| Parameter | Type | Passing | Description |
|---|---|---|---|
argParameters | string | ref | The parameter string that receives the settings. |
Returns: nothing (void)
Writes whether mechanical layers 1 to 16 are included with all plots, and the PlotLayer and FlipLayer selections of all plot layers.
Export_ToParameters_LayerOptions_Version3
Writes the layer settings to a parameter string in the version 3 layer numbering.
void Export_ToParameters_LayerOptions_Version3(ref string argParameters);
| Parameter | Type | Passing | Description |
|---|---|---|---|
argParameters | string | ref | The parameter string that receives the settings. |
Returns: nothing (void)
Writes whether mechanical layers 1 to 4 are included with all plots, and the PlotLayer and FlipLayer selections of each plot layer that has a version 3 equivalent; other layers are left out.
Import_FromParameters_GeneralOptions
Reads the general output settings from a parameter string.
void Import_FromParameters_GeneralOptions(TUnit argDisplayUnit, string argParameters);
void Import_FromParameters_GeneralOptions(int argDisplayUnit, string argParameters);
| Parameter | Type | Passing | Description |
|---|---|---|---|
argDisplayUnit | TUnit | value | The unit used to read the coordinate values DrillGuideHoleSize and DrillDrawSymbolSize. |
argParameters | string | value | The parameter string to read. |
Returns: nothing (void)
The first overload is an extension method of IPCB_OutputOptionsHelper (using PCB;) with typed parameters; the second is declared by the interface.
Reads the parameters that Export_ToParameters_GeneralOptions writes; the layer settings are read by Import_FromParameters_LayerOptions.
Import_FromParameters_LayerOptions
Reads the layer settings from a parameter string.
void Import_FromParameters_LayerOptions(string argParameters);
| Parameter | Type | Passing | Description |
|---|---|---|---|
argParameters | string | value | The parameter string to read. |
Returns: nothing (void)
Reads the settings that Export_ToParameters_LayerOptions writes. When the string holds only the older layer selection with one character per plot layer, plot layers beyond its end keep their current value. When the string holds no layer selection, PlotLayer and FlipLayer are not changed.
Import_FromParameters_LayerOptions_Version3
Reads the layer settings from a parameter string that uses the version 3 layer numbering.
void Import_FromParameters_LayerOptions_Version3(string argParameters);
| Parameter | Type | Passing | Description |
|---|---|---|---|
argParameters | string | value | The parameter string to read. |
Returns: nothing (void)
Reads whether mechanical layers 1 to 4 are included with all plots and the PlotLayer and FlipLayer selections, and converts each version 3 plot layer to the corresponding current plot layer. Plot layers that have no version 3 equivalent are not changed.
Inherited members
- From IPCB_AbstractOptions: Export_ToParameters, Export_ToParameters_Version3, Export_ToParameters_Version4, Import_FromParameters, Import_FromParameters_Version3, Import_FromParameters_Version4, ObjectID