@windypro-rourou/dsh-eda 0.1.0 → 0.1.1

package/skill/references/interfaces/IPCB_PrimitiveAPI.md

@@ -0,0 +1,175 @@
+# IPCB\_PrimitiveAPI interface
+
+PCB primitive API
+
+## Signature
+
+```typescript
+interface IPCB_PrimitiveAPI
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[create](./IPCB_PrimitiveAPI.md)
+
+</td><td>
+
+</td><td>
+
+(...args: any\[\]) =&gt; [IPCB\_Primitive](./IPCB_Primitive.md) \| undefined \| Promise&lt;[IPCB\_Primitive](./IPCB_Primitive.md)<!-- -->&gt; \| Promise&lt;[IPCB\_Primitive](./IPCB_Primitive.md) \| undefined&gt;
+
+</td><td>
+
+</td></tr>
+<tr><td>
+
+[delete](./IPCB_PrimitiveAPI.md)
+
+</td><td>
+
+</td><td>
+
+(primitiveIds: string \| any \| Array&lt;string&gt; \| Array&lt;any&gt;) =&gt; boolean \| Promise&lt;boolean&gt;
+
+</td><td>
+
+</td></tr>
+<tr><td>
+
+[get](./IPCB_PrimitiveAPI.md)
+
+</td><td>
+
+</td><td>
+
+((primitiveIds: string) =&gt; [IPCB\_Primitive](./IPCB_Primitive.md) \| undefined \| Promise&lt;[IPCB\_Primitive](./IPCB_Primitive.md) \| undefined&gt;) &amp; ((primitiveIds: string\[\]) =&gt; Array&lt;[IPCB\_Primitive](./IPCB_Primitive.md)<!-- -->&gt; \| Promise&lt;Array&lt;[IPCB\_Primitive](./IPCB_Primitive.md)<!-- -->&gt;&gt;)
+
+</td><td>
+
+</td></tr>
+<tr><td>
+
+[getAll](./IPCB_PrimitiveAPI.md)
+
+</td><td>
+
+</td><td>
+
+(...args: any\[\]) =&gt; Array&lt;[IPCB\_Primitive](./IPCB_Primitive.md)<!-- -->&gt; \| Promise&lt;Array&lt;[IPCB\_Primitive](./IPCB_Primitive.md)<!-- -->&gt;&gt;
+
+</td><td>
+
+</td></tr>
+<tr><td>
+
+[getAllPrimitiveId](./IPCB_PrimitiveAPI.md)
+
+</td><td>
+
+</td><td>
+
+(...args: any\[\]) =&gt; Array&lt;string&gt; \| Promise&lt;Array&lt;string&gt;&gt;
+
+</td><td>
+
+</td></tr>
+<tr><td>
+
+[modify](./IPCB_PrimitiveAPI.md)
+
+</td><td>
+
+</td><td>
+
+(primitiveId: string \| any, ...args: any\[\]) =&gt; [IPCB\_Primitive](./IPCB_Primitive.md) \| undefined \| Promise&lt;[IPCB\_Primitive](./IPCB_Primitive.md)<!-- -->&gt; \| Promise&lt;[IPCB\_Primitive](./IPCB_Primitive.md) \| undefined&gt;
+
+</td><td>
+
+</td></tr>
+</tbody></table>
+
+---
+
+## 属性详情
+
+### create
+
+# IPCB\_PrimitiveAPI.create property
+
+## Signature
+
+```typescript
+create: (...args: any[]) =>
+	IPCB_Primitive | undefined | Promise<IPCB_Primitive> | Promise<IPCB_Primitive | undefined>;
+```
+
+### delete
+
+# IPCB\_PrimitiveAPI.delete property
+
+## Signature
+
+```typescript
+delete: (primitiveIds: string | any | Array<string> | Array<any>) => boolean | Promise<boolean>;
+```
+
+### get
+
+# IPCB\_PrimitiveAPI.get property
+
+## Signature
+
+```typescript
+get: ((primitiveIds: string) => IPCB_Primitive | undefined | Promise<IPCB_Primitive | undefined>)
+	& ((primitiveIds: string[]) => Array<IPCB_Primitive> | Promise<Array<IPCB_Primitive>>);
+```
+
+### getall
+
+# IPCB\_PrimitiveAPI.getAll property
+
+## Signature
+
+```typescript
+getAll: (...args: any[]) => Array<IPCB_Primitive> | Promise<Array<IPCB_Primitive>>;
+```
+
+### getallprimitiveid
+
+# IPCB\_PrimitiveAPI.getAllPrimitiveId property
+
+## Signature
+
+```typescript
+getAllPrimitiveId: (...args: any[]) => Array<string> | Promise<Array<string>>;
+```
+
+### modify
+
+# IPCB\_PrimitiveAPI.modify property
+
+## Signature
+
+```typescript
+modify: (primitiveId: string | any, ...args: any[]) =>
+	IPCB_Primitive | undefined | Promise<IPCB_Primitive> | Promise<IPCB_Primitive | undefined>;
+```

package/skill/references/interfaces/IPCB_PrimitivePadHeatWelding.md

@@ -0,0 +1,151 @@
+# IPCB\_PrimitivePadHeatWelding interface
+
+Pad thermal relief optimization parameters
+
+## Signature
+
+```typescript
+interface IPCB_PrimitivePadHeatWelding
+```
+
+## Remarks
+
+When the connection method ([connectionMethod](./IPCB_PrimitivePadHeatWelding.md)<!-- -->) is direct connection ([DIRECT\_CONNECTED](../enums/EPCB_PrimitivePadHeatWeldingConnectionMethod.md)<!-- -->) or no connection ([NON\_CONNECTED](../enums/EPCB_PrimitivePadHeatWeldingConnectionMethod.md)<!-- -->), the settings of divergence spacing, divergence line width, and divergence angle will be ignored
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[connectionMethod](./IPCB_PrimitivePadHeatWelding.md)
+
+</td><td>
+
+</td><td>
+
+[EPCB\_PrimitivePadHeatWeldingConnectionMethod](../enums/EPCB_PrimitivePadHeatWeldingConnectionMethod.md)
+
+</td><td>
+
+Connection method
+
+</td></tr>
+<tr><td>
+
+[divergenceAngle?](./IPCB_PrimitivePadHeatWelding.md)
+
+</td><td>
+
+</td><td>
+
+number
+
+</td><td>
+
+_(Optional)_ Divergence angle
+
+</td></tr>
+<tr><td>
+
+[divergenceLineWidth?](./IPCB_PrimitivePadHeatWelding.md)
+
+</td><td>
+
+</td><td>
+
+number
+
+</td><td>
+
+_(Optional)_ Divergence line width
+
+</td></tr>
+<tr><td>
+
+[divergenceSpacing?](./IPCB_PrimitivePadHeatWelding.md)
+
+</td><td>
+
+</td><td>
+
+number
+
+</td><td>
+
+_(Optional)_ Divergence spacing
+
+</td></tr>
+</tbody></table>
+
+---
+
+## 属性详情
+
+### divergenceangle
+
+# IPCB\_PrimitivePadHeatWelding.divergenceAngle property
+
+Divergence angle
+
+## Signature
+
+```typescript
+divergenceAngle?: number;
+```
+
+### divergencelinewidth
+
+# IPCB\_PrimitivePadHeatWelding.divergenceLineWidth property
+
+Divergence line width
+
+## Signature
+
+```typescript
+divergenceLineWidth?: number;
+```
+
+### divergencespacing
+
+# IPCB\_PrimitivePadHeatWelding.divergenceSpacing property
+
+Divergence spacing
+
+## Signature
+
+```typescript
+divergenceSpacing?: number;
+```
+
+
+---
+
+## 方法详情
+
+### connectionmethod
+
+# IPCB\_PrimitivePadHeatWelding.connectionMethod property
+
+Connection method
+
+## Signature
+
+```typescript
+connectionMethod: EPCB_PrimitivePadHeatWeldingConnectionMethod;
+```

package/skill/references/interfaces/IPCB_PrimitivePouredPourFill.md

@@ -0,0 +1,142 @@
+# IPCB\_PrimitivePouredPourFill interface
+
+Copper fill region
+
+## Signature
+
+```typescript
+interface IPCB_PrimitivePouredPourFill
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[fill](./IPCB_PrimitivePouredPourFill.md)
+
+</td><td>
+
+</td><td>
+
+boolean
+
+</td><td>
+
+Whether to fill
+
+</td></tr>
+<tr><td>
+
+[id](./IPCB_PrimitivePouredPourFill.md)
+
+</td><td>
+
+</td><td>
+
+string
+
+</td><td>
+
+ID
+
+</td></tr>
+<tr><td>
+
+[lineWidth](./IPCB_PrimitivePouredPourFill.md)
+
+</td><td>
+
+</td><td>
+
+number
+
+</td><td>
+
+Line width
+
+</td></tr>
+<tr><td>
+
+[path](./IPCB_PrimitivePouredPourFill.md)
+
+</td><td>
+
+</td><td>
+
+[IPCB\_ComplexPolygon](../classes/IPCB_ComplexPolygon.md)
+
+</td><td>
+
+Complex polygon
+
+</td></tr>
+</tbody></table>
+
+---
+
+## 属性详情
+
+### fill
+
+# IPCB\_PrimitivePouredPourFill.fill property
+
+Whether to fill
+
+## Signature
+
+```typescript
+fill: boolean;
+```
+
+### id
+
+# IPCB\_PrimitivePouredPourFill.id property
+
+ID
+
+## Signature
+
+```typescript
+id: string;
+```
+
+### linewidth
+
+# IPCB\_PrimitivePouredPourFill.lineWidth property
+
+Line width
+
+## Signature
+
+```typescript
+lineWidth: number;
+```
+
+### path
+
+# IPCB\_PrimitivePouredPourFill.path property
+
+Complex polygon
+
+## Signature
+
+```typescript
+path: IPCB_ComplexPolygon;
+```

package/skill/references/interfaces/IPCB_PrimitiveSolderMaskAndPasteMaskExpansion.md

@@ -0,0 +1,154 @@
+# IPCB\_PrimitiveSolderMaskAndPasteMaskExpansion interface
+
+Solder mask / paste mask expansion
+
+## Signature
+
+```typescript
+interface IPCB_PrimitiveSolderMaskAndPasteMaskExpansion
+```
+
+## Remarks
+
+This parameter setting includes the following three cases:
+
+1. When the primitive is a top/bottom layer SMD pad, the solder mask/paste mask expansion of the corresponding layer can be set; other settings have no effect
+
+2. When the primitive is a through-hole pad, the solder mask expansion of the top/bottom layer can be set; paste mask expansion settings have no effect
+
+3. When the primitive is a via, the solder mask expansion of the top/bottom layer can be set; paste mask expansion settings have no effect. If it is a blind via, its solder mask expansion setting takes effect according to its exposed layer
+
+The paste mask expansion is generally only used for specific purposes such as stencil production. If you do not understand its function, feel free to ignore its parameter settings
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[bottomPasteMask?](./IPCB_PrimitiveSolderMaskAndPasteMaskExpansion.md)
+
+</td><td>
+
+</td><td>
+
+number
+
+</td><td>
+
+_(Optional)_ Bottom paste mask expansion
+
+</td></tr>
+<tr><td>
+
+[bottomSolderMask?](./IPCB_PrimitiveSolderMaskAndPasteMaskExpansion.md)
+
+</td><td>
+
+</td><td>
+
+number
+
+</td><td>
+
+_(Optional)_ Bottom solder mask expansion
+
+</td></tr>
+<tr><td>
+
+[topPasteMask?](./IPCB_PrimitiveSolderMaskAndPasteMaskExpansion.md)
+
+</td><td>
+
+</td><td>
+
+number
+
+</td><td>
+
+_(Optional)_ Top paste mask expansion
+
+</td></tr>
+<tr><td>
+
+[topSolderMask?](./IPCB_PrimitiveSolderMaskAndPasteMaskExpansion.md)
+
+</td><td>
+
+</td><td>
+
+number
+
+</td><td>
+
+_(Optional)_ Top solder mask expansion
+
+</td></tr>
+</tbody></table>
+
+---
+
+## 属性详情
+
+### bottompastemask
+
+# IPCB\_PrimitiveSolderMaskAndPasteMaskExpansion.bottomPasteMask property
+
+Bottom paste mask expansion
+
+## Signature
+
+```typescript
+bottomPasteMask?: number;
+```
+
+### bottomsoldermask
+
+# IPCB\_PrimitiveSolderMaskAndPasteMaskExpansion.bottomSolderMask property
+
+Bottom solder mask expansion
+
+## Signature
+
+```typescript
+bottomSolderMask?: number;
+```
+
+### toppastemask
+
+# IPCB\_PrimitiveSolderMaskAndPasteMaskExpansion.topPasteMask property
+
+Top paste mask expansion
+
+## Signature
+
+```typescript
+topPasteMask?: number;
+```
+
+### topsoldermask
+
+# IPCB\_PrimitiveSolderMaskAndPasteMaskExpansion.topSolderMask property
+
+Top solder mask expansion
+
+## Signature
+
+```typescript
+topSolderMask?: number;
+```

package/skill/references/interfaces/IPCB_SubstratePhysicalProperties.md

@@ -0,0 +1,88 @@
+# IPCB\_SubstratePhysicalProperties interface
+
+Substrate physical properties
+
+## Signature
+
+```typescript
+interface IPCB_SubstratePhysicalProperties
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[numberOfLayers](./IPCB_SubstratePhysicalProperties.md)
+
+</td><td>
+
+</td><td>
+
+[TPCB\_NumberOfCopperLayers](../types/TPCB_NumberOfCopperLayers.md)
+
+</td><td>
+
+Number of copper layers
+
+</td></tr>
+<tr><td>
+
+[substrateMaterial](./IPCB_SubstratePhysicalProperties.md)
+
+</td><td>
+
+</td><td>
+
+'Common' \| 'FPC Flexible'
+
+</td><td>
+
+Substrate material
+
+</td></tr>
+</tbody></table>
+
+---
+
+## 属性详情
+
+### numberoflayers
+
+# IPCB\_SubstratePhysicalProperties.numberOfLayers property
+
+Number of copper layers
+
+## Signature
+
+```typescript
+numberOfLayers: TPCB_NumberOfCopperLayers;
+```
+
+### substratematerial
+
+# IPCB\_SubstratePhysicalProperties.substrateMaterial property
+
+Substrate material
+
+## Signature
+
+```typescript
+substrateMaterial: 'Common' | 'FPC Flexible';
+```