@windypro-rourou/dsh-eda 0.1.0 → 0.1.2

package/skill/references/interfaces/IRawNet.md

@@ -0,0 +1,103 @@
+# IRawNet interface
+
+Raw data - net
+
+## Signature
+
+```typescript
+interface IRawNet
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[designatorPinName](./IRawNet.md)
+
+</td><td>
+
+</td><td>
+
+string \| null
+
+</td><td>
+
+</td></tr>
+<tr><td>
+
+[nlNet](./IRawNet.md)
+
+</td><td>
+
+</td><td>
+
+string
+
+</td><td>
+
+</td></tr>
+<tr><td>
+
+[wires](./IRawNet.md)
+
+</td><td>
+
+</td><td>
+
+Array&lt;[IRawWire](./IRawWire.md)<!-- -->&gt;
+
+</td><td>
+
+</td></tr>
+</tbody></table>
+
+---
+
+## 属性详情
+
+### designatorpinname
+
+# IRawNet.designatorPinName property
+
+## Signature
+
+```typescript
+designatorPinName: string | null;
+```
+
+### nlnet
+
+# IRawNet.nlNet property
+
+## Signature
+
+```typescript
+nlNet: string;
+```
+
+### wires
+
+# IRawNet.wires property
+
+## Signature
+
+```typescript
+wires: Array<IRawWire>;
+```

package/skill/references/interfaces/IRawPureSchematic.md

@@ -0,0 +1,80 @@
+# IRawPureSchematic interface
+
+Raw data - pureSchematic
+
+## Signature
+
+```typescript
+interface IRawPureSchematic
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[nlNetWires](./IRawPureSchematic.md)
+
+</td><td>
+
+</td><td>
+
+Array&lt;[IRawNet](./IRawNet.md)<!-- -->&gt;
+
+</td><td>
+
+</td></tr>
+<tr><td>
+
+[sheets](./IRawPureSchematic.md)
+
+</td><td>
+
+</td><td>
+
+\{ \[key: string\]: \{ uuid: string; title: string; displayTitle: string; zIndex: number \} \}
+
+</td><td>
+
+</td></tr>
+</tbody></table>
+
+---
+
+## 属性详情
+
+### nlnetwires
+
+# IRawPureSchematic.nlNetWires property
+
+## Signature
+
+```typescript
+nlNetWires: Array<IRawNet>;
+```
+
+### sheets
+
+# IRawPureSchematic.sheets property
+
+## Signature
+
+```typescript
+sheets: { [key: string]: { uuid: string; title: string; displayTitle: string; zIndex: number } };
+```

package/skill/references/interfaces/IRawSchematic.md

@@ -0,0 +1,103 @@
+# IRawSchematic interface
+
+Raw data - schematic
+
+## Signature
+
+```typescript
+interface IRawSchematic
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[board](./IRawSchematic.md)
+
+</td><td>
+
+</td><td>
+
+string
+
+</td><td>
+
+</td></tr>
+<tr><td>
+
+[displayTitle](./IRawSchematic.md)
+
+</td><td>
+
+</td><td>
+
+string
+
+</td><td>
+
+</td></tr>
+<tr><td>
+
+[title](./IRawSchematic.md)
+
+</td><td>
+
+</td><td>
+
+string
+
+</td><td>
+
+</td></tr>
+</tbody></table>
+
+---
+
+## 属性详情
+
+### board
+
+# IRawSchematic.board property
+
+## Signature
+
+```typescript
+board: string;
+```
+
+### displaytitle
+
+# IRawSchematic.displayTitle property
+
+## Signature
+
+```typescript
+displayTitle: string;
+```
+
+### title
+
+# IRawSchematic.title property
+
+## Signature
+
+```typescript
+title: string;
+```

package/skill/references/interfaces/IRawWire.md

@@ -0,0 +1,149 @@
+# IRawWire interface
+
+Raw data - wire
+
+## Signature
+
+```typescript
+interface IRawWire
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[net](./IRawWire.md)
+
+</td><td>
+
+</td><td>
+
+string
+
+</td><td>
+
+</td></tr>
+<tr><td>
+
+[netName](./IRawWire.md)
+
+</td><td>
+
+</td><td>
+
+string\[\]
+
+</td><td>
+
+</td></tr>
+<tr><td>
+
+[nlNet](./IRawWire.md)
+
+</td><td>
+
+</td><td>
+
+string
+
+</td><td>
+
+</td></tr>
+<tr><td>
+
+[path](./IRawWire.md)
+
+</td><td>
+
+</td><td>
+
+string
+
+</td><td>
+
+</td></tr>
+<tr><td>
+
+[wirePath](./IRawWire.md)
+
+</td><td>
+
+</td><td>
+
+string
+
+</td><td>
+
+</td></tr>
+</tbody></table>
+
+---
+
+## 属性详情
+
+### net
+
+# IRawWire.net property
+
+## Signature
+
+```typescript
+net: string;
+```
+
+### netname
+
+# IRawWire.netName property
+
+## Signature
+
+```typescript
+netName: string[];
+```
+
+### nlnet
+
+# IRawWire.nlNet property
+
+## Signature
+
+```typescript
+nlNet: string;
+```
+
+### path
+
+# IRawWire.path property
+
+## Signature
+
+```typescript
+path: string;
+```
+
+### wirepath
+
+# IRawWire.wirePath property
+
+## Signature
+
+```typescript
+wirePath: string;
+```

package/skill/references/interfaces/ISCH_DrcError.md

@@ -0,0 +1,142 @@
+# ISCH\_DrcError interface
+
+DRC error item
+
+## Signature
+
+```typescript
+interface ISCH_DrcError
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[net?](./ISCH_DrcError.md)
+
+</td><td>
+
+</td><td>
+
+string
+
+</td><td>
+
+_(Optional)_ Involved net (if any)
+
+</td></tr>
+<tr><td>
+
+[primitives](./ISCH_DrcError.md)
+
+</td><td>
+
+</td><td>
+
+Array&lt;[ISCH\_DrcErrorPrimitive](./ISCH_DrcErrorPrimitive.md)<!-- -->&gt;
+
+</td><td>
+
+Involved primitives
+
+</td></tr>
+<tr><td>
+
+[rule](./ISCH_DrcError.md)
+
+</td><td>
+
+</td><td>
+
+string
+
+</td><td>
+
+Triggered rule key, e.g. `IN-IN`<!-- -->, `OUT-OUT`
+
+</td></tr>
+<tr><td>
+
+[type](./ISCH_DrcError.md)
+
+</td><td>
+
+</td><td>
+
+'fatalError' \| 'error' \| 'warn'
+
+</td><td>
+
+Error level
+
+</td></tr>
+</tbody></table>
+
+---
+
+## 属性详情
+
+### net
+
+# ISCH\_DrcError.net property
+
+Involved net (if any)
+
+## Signature
+
+```typescript
+net?: string;
+```
+
+### primitives
+
+# ISCH\_DrcError.primitives property
+
+Involved primitives
+
+## Signature
+
+```typescript
+primitives: Array<ISCH_DrcErrorPrimitive>;
+```
+
+### rule
+
+# ISCH\_DrcError.rule property
+
+Triggered rule key, e.g. `IN-IN`<!-- -->, `OUT-OUT`
+
+## Signature
+
+```typescript
+rule: string;
+```
+
+### type
+
+# ISCH\_DrcError.type property
+
+Error level
+
+## Signature
+
+```typescript
+type: 'fatalError' | 'error' | 'warn';
+```

package/skill/references/interfaces/ISCH_DrcErrorPrimitive.md

@@ -0,0 +1,142 @@
+# ISCH\_DrcErrorPrimitive interface
+
+Primitive involved in a DRC error
+
+## Signature
+
+```typescript
+interface ISCH_DrcErrorPrimitive
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[designator?](./ISCH_DrcErrorPrimitive.md)
+
+</td><td>
+
+</td><td>
+
+string
+
+</td><td>
+
+_(Optional)_ Designator, e.g. `R1`
+
+</td></tr>
+<tr><td>
+
+[name?](./ISCH_DrcErrorPrimitive.md)
+
+</td><td>
+
+</td><td>
+
+string
+
+</td><td>
+
+_(Optional)_ Primitive name (pin number / net name / device name, depending on the rule)
+
+</td></tr>
+<tr><td>
+
+[primitiveId](./ISCH_DrcErrorPrimitive.md)
+
+</td><td>
+
+</td><td>
+
+string
+
+</td><td>
+
+Primitive ID (can be used for canvas jump positioning)
+
+</td></tr>
+<tr><td>
+
+[sheet?](./ISCH_DrcErrorPrimitive.md)
+
+</td><td>
+
+</td><td>
+
+string
+
+</td><td>
+
+_(Optional)_ Sheet ID it is on
+
+</td></tr>
+</tbody></table>
+
+---
+
+## 属性详情
+
+### designator
+
+# ISCH\_DrcErrorPrimitive.designator property
+
+Designator, e.g. `R1`
+
+## Signature
+
+```typescript
+designator?: string;
+```
+
+### name
+
+# ISCH\_DrcErrorPrimitive.name property
+
+Primitive name (pin number / net name / device name, depending on the rule)
+
+## Signature
+
+```typescript
+name?: string;
+```
+
+### primitiveid
+
+# ISCH\_DrcErrorPrimitive.primitiveId property
+
+Primitive ID (can be used for canvas jump positioning)
+
+## Signature
+
+```typescript
+primitiveId: string;
+```
+
+### sheet
+
+# ISCH\_DrcErrorPrimitive.sheet property
+
+Sheet ID it is on
+
+## Signature
+
+```typescript
+sheet?: string;
+```