@windypro-rourou/dsh-eda 0.1.0 → 0.1.2

package/skill/references/classes/LIB_SimulationModel.md

@@ -0,0 +1,821 @@
+# LIB\_SimulationModel class
+
+Comprehensive library / simulation model class
+
+## Signature
+
+```typescript
+class LIB_SimulationModel
+```
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[copy(simulationModelUuid, libraryUuid, targetLibraryUuid, targetClassification, newSimulationModelName)](./LIB_SimulationModel.md)
+
+</td><td>
+
+</td><td>
+
+**_(BETA)_** Copy the simulation model
+
+</td></tr>
+<tr><td>
+
+[create(libraryUuid, model, classification, description)](./LIB_SimulationModel.md)
+
+</td><td>
+
+</td><td>
+
+**_(BETA)_** Create a simulation model
+
+</td></tr>
+<tr><td>
+
+[delete(simulationModelUuid, libraryUuid)](./LIB_SimulationModel.md)
+
+</td><td>
+
+</td><td>
+
+**_(BETA)_** Delete the simulation model
+
+</td></tr>
+<tr><td>
+
+[get(simulationModelUuid, libraryUuid)](./LIB_SimulationModel.md)
+
+</td><td>
+
+</td><td>
+
+**_(BETA)_** Get all properties of the simulation model
+
+</td></tr>
+<tr><td>
+
+[modify(simulationModelUuid, libraryUuid, modelProps, classification, description)](./LIB_SimulationModel.md)
+
+</td><td>
+
+</td><td>
+
+**_(BETA)_** Modify the simulation model
+
+</td></tr>
+<tr><td>
+
+[search(key, libraryUuid, classification, simulationModelType, itemsOfPage, page)](./LIB_SimulationModel.md)
+
+</td><td>
+
+</td><td>
+
+**_(BETA)_** Search simulation models
+
+</td></tr>
+</tbody></table>
+
+---
+
+## 方法详情
+
+### copy
+
+# LIB\_SimulationModel.copy() method
+
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+
+Copy the simulation model
+
+## Signature
+
+```typescript
+function copy(
+	simulationModelUuid: string,
+	libraryUuid: string,
+	targetLibraryUuid: string,
+	targetClassification?: Array<string>,
+	newSimulationModelName?: string,
+): Promise<string | undefined>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody><tr><td>
+
+simulationModelUuid
+
+</td><td>
+
+string
+
+</td><td>
+
+Simulation model UUID
+
+</td></tr>
+<tr><td>
+
+libraryUuid
+
+</td><td>
+
+string
+
+</td><td>
+
+Library UUID, you can use [LIB\_LibrariesList](./LIB_LibrariesList.md) APIs in
+
+</td></tr>
+<tr><td>
+
+targetLibraryUuid
+
+</td><td>
+
+string
+
+</td><td>
+
+Target library UUID
+
+</td></tr>
+<tr><td>
+
+targetClassification
+
+</td><td>
+
+Array&lt;string&gt;
+
+</td><td>
+
+_(Optional)_ Classification in the target library
+
+</td></tr>
+<tr><td>
+
+newSimulationModelName
+
+</td><td>
+
+string
+
+</td><td>
+
+_(Optional)_ New simulation model name. If a symbol with the same name exists in the target library, the copy will fail
+
+</td></tr>
+</tbody></table>
+
+## Returns
+
+Promise&lt;string \| undefined&gt;
+
+UUID of the new simulation model in the target library
+
+## Remarks
+
+ADD since EDA v3.2.167
+
+## Example
+
+```javascript
+// 1. 获取个人库 UUID，并新建一个仿真模型作为复制来源
+const libraryUuid = await eda.lib_LibrariesList.getPersonalLibraryUuid();
+const sourceName = `嘉立创示例_仿真模型来源_${Date.now()}`;
+const sourceUuid = await eda.lib_SimulationModel.create(libraryUuid, {
+	modelType: 'Ngspice',
+	modelData: '* 示例电阻模型\n.model EXAMPLE_RES RES(R=1k)\n',
+	modelName: sourceName,
+});
+
+// 2. 同库复制，指定新名称避免同名冲突（分类传 [] = 不分类）
+const newName = `嘉立创示例_仿真模型副本_${Date.now()}`;
+const copiedUuid = await eda.lib_SimulationModel.copy(
+	sourceUuid,
+	libraryUuid,
+	libraryUuid,
+	[],
+	newName
+);
+
+// 创建类保留现场（副本留在个人库中供观察）
+
+console.log('sourceUuid:', sourceUuid);
+console.log('copiedUuid:', copiedUuid);
+console.log('newName:', newName);
+```
+
+### create
+
+# LIB\_SimulationModel.create() method
+
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+
+Create a simulation model
+
+## Signature
+
+```typescript
+function create(
+	libraryUuid: string,
+	model: { modelType: 'Ngspice' } & (
+		| {
+			modelFile: Blob;
+			modelName?: undefined | string;
+			modelCategory?: undefined | string;
+			modelPin?: undefined | string;
+		}
+		| {
+			modelData: string;
+			modelName?: undefined | string;
+			modelCategory?: undefined | string;
+			modelPin?: undefined | string;
+		}
+	),
+	classification?: Array<string>,
+	description?: string,
+): Promise<string | undefined>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody><tr><td>
+
+libraryUuid
+
+</td><td>
+
+string
+
+</td><td>
+
+Library UUID, you can use [LIB\_LibrariesList](./LIB_LibrariesList.md) APIs in
+
+</td></tr>
+<tr><td>
+
+model
+
+</td><td>
+
+{ modelType: 'Ngspice' } &amp; ({ modelFile: Blob; modelName?: undefined \| string; modelCategory?: undefined \| string; modelPin?: undefined \| string } \| { modelData: string; modelName?: undefined \| string; modelCategory?: undefined \| string; modelPin?: undefined \| string })
+
+</td><td>
+
+Simulation model data
+
+</td></tr>
+<tr><td>
+
+classification
+
+</td><td>
+
+Array&lt;string&gt;
+
+</td><td>
+
+_(Optional)_ Classification
+
+</td></tr>
+<tr><td>
+
+description
+
+</td><td>
+
+string
+
+</td><td>
+
+_(Optional)_ Description
+
+</td></tr>
+</tbody></table>
+
+## Returns
+
+Promise&lt;string \| undefined&gt;
+
+Simulation model UUID
+
+## Remarks
+
+ADD since EDA v3.2.167
+
+## Example
+
+```javascript
+// 1. 获取个人库 UUID
+const libraryUuid = await eda.lib_LibrariesList.getPersonalLibraryUuid();
+
+// 2. 创建 Ngspice 仿真模型（modelData 传 .model 语句文本，分类传 [] = 不分类）
+const modelName = `嘉立创示例_新仿真模型_${Date.now()}`;
+const simulationModelUuid = await eda.lib_SimulationModel.create(
+	libraryUuid,
+	{
+		modelType: 'Ngspice',
+		modelData: '* 示例电阻模型\n.model EXAMPLE_RES RES(R=1k)\n',
+		modelName,
+		modelPin: '1,2',
+	},
+	[],
+	'示例仿真模型描述'
+);
+
+// 创建类保留现场（新仿真模型留在个人库中供观察）
+
+console.log('simulationModelUuid:', simulationModelUuid);
+console.log('modelName:', modelName);
+```
+
+### delete
+
+# LIB\_SimulationModel.delete() method
+
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+
+Delete the simulation model
+
+## Signature
+
+```typescript
+function delete(simulationModelUuid: string, libraryUuid: string): Promise<boolean>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody><tr><td>
+
+simulationModelUuid
+
+</td><td>
+
+string
+
+</td><td>
+
+Simulation model UUID
+
+</td></tr>
+<tr><td>
+
+libraryUuid
+
+</td><td>
+
+string
+
+</td><td>
+
+Library UUID, you can use [LIB\_LibrariesList](./LIB_LibrariesList.md) APIs in
+
+</td></tr>
+</tbody></table>
+
+## Returns
+
+Promise&lt;boolean&gt;
+
+Whether the operation is successful
+
+## Remarks
+
+ADD since EDA v3.2.167
+
+## Example
+
+```javascript
+// 1. 获取个人库 UUID 并新建删除对象
+const libraryUuid = await eda.lib_LibrariesList.getPersonalLibraryUuid();
+const simulationModelUuid = await eda.lib_SimulationModel.create(
+	libraryUuid,
+	{
+		modelType: 'Ngspice',
+		modelData: '* 示例电阻模型\n.model EXAMPLE_RES RES(R=1k)\n',
+		modelName: `嘉立创示例_待删除仿真模型_${Date.now()}`,
+	},
+	[]
+);
+
+// 2. 删除该仿真模型
+const deleted = await eda.lib_SimulationModel.delete(simulationModelUuid, libraryUuid);
+
+console.log('simulationModelUuid:', simulationModelUuid);
+console.log('deleted:', deleted);
+```
+
+### get
+
+# LIB\_SimulationModel.get() method
+
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+
+Get all properties of the simulation model
+
+## Signature
+
+```typescript
+function get(
+	simulationModelUuid: string,
+	libraryUuid?: string,
+): Promise<ILIB_SimulationModelItem | undefined>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody><tr><td>
+
+simulationModelUuid
+
+</td><td>
+
+string
+
+</td><td>
+
+Simulation model UUID
+
+</td></tr>
+<tr><td>
+
+libraryUuid
+
+</td><td>
+
+string
+
+</td><td>
+
+_(Optional)_ Library UUID, default is system library, you can use [LIB\_LibrariesList](./LIB_LibrariesList.md) APIs in
+
+</td></tr>
+</tbody></table>
+
+## Returns
+
+Promise&lt;[ILIB\_SimulationModelItem](../interfaces/ILIB_SimulationModelItem.md) \| undefined&gt;
+
+Simulation model properties
+
+## Remarks
+
+Note: This API is only valid for the private deployment edition. Calling it in other editions will always `throw Error` ADD since EDA v3.2.167
+
+### modify
+
+# LIB\_SimulationModel.modify() method
+
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+
+Modify the simulation model
+
+## Signature
+
+```typescript
+function modify(
+	simulationModelUuid: string,
+	libraryUuid: string,
+	modelProps?: {
+		modelName?: undefined | string;
+		modelCategory?: undefined | string;
+		modelPin?: undefined | string;
+	},
+	classification?: Array<string> | null,
+	description?: string | null,
+): Promise<boolean>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody><tr><td>
+
+simulationModelUuid
+
+</td><td>
+
+string
+
+</td><td>
+
+Simulation model UUID
+
+</td></tr>
+<tr><td>
+
+libraryUuid
+
+</td><td>
+
+string
+
+</td><td>
+
+Library UUID, you can use [LIB\_LibrariesList](./LIB_LibrariesList.md) APIs in
+
+</td></tr>
+<tr><td>
+
+modelProps
+
+</td><td>
+
+\{ modelName?: undefined \| string; modelCategory?: undefined \| string; modelPin?: undefined \| string \}
+
+</td><td>
+
+_(Optional)_ Simulation model properties
+
+</td></tr>
+<tr><td>
+
+classification
+
+</td><td>
+
+Array&lt;string&gt; \| null
+
+</td><td>
+
+_(Optional)_ Classification
+
+</td></tr>
+<tr><td>
+
+description
+
+</td><td>
+
+string \| null
+
+</td><td>
+
+_(Optional)_ Description
+
+</td></tr>
+</tbody></table>
+
+## Returns
+
+Promise&lt;boolean&gt;
+
+Whether the operation is successful
+
+## Remarks
+
+If you want to clear certain properties, set their values to `null` ADD since EDA v3.2.167
+
+## Example
+
+```javascript
+// 1. 获取个人库 UUID 并新建修改对象
+const libraryUuid = await eda.lib_LibrariesList.getPersonalLibraryUuid();
+const simulationModelUuid = await eda.lib_SimulationModel.create(
+	libraryUuid,
+	{
+		modelType: 'Ngspice',
+		modelData: '* 示例电阻模型\n.model EXAMPLE_RES RES(R=1k)\n',
+		modelName: `嘉立创示例_仿真模型修改前_${Date.now()}`,
+	},
+	[],
+	'修改前的描述'
+);
+
+// 2. 修改名称和描述（分类保持不变传 []）
+const newName = `嘉立创示例_仿真模型修改后_${Date.now()}`;
+const modified = await eda.lib_SimulationModel.modify(
+	simulationModelUuid,
+	libraryUuid,
+	{ modelName: newName },
+	[],
+	'修改后的描述'
+);
+
+// 修改类保留现场
+
+console.log('simulationModelUuid:', simulationModelUuid);
+console.log('modified:', modified);
+console.log('newName:', newName);
+```
+
+### search
+
+# LIB\_SimulationModel.search() method
+
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+
+Search simulation models
+
+## Signature
+
+```typescript
+function search(
+	key: string,
+	libraryUuid?: string,
+	classification?: Array<string>,
+	simulationModelType?: ELIB_SimulationModelType,
+	itemsOfPage?: number,
+	page?: number,
+): Promise<Array<ILIB_SimulationModelSearchItem>>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody><tr><td>
+
+key
+
+</td><td>
+
+string
+
+</td><td>
+
+Search keyword
+
+</td></tr>
+<tr><td>
+
+libraryUuid
+
+</td><td>
+
+string
+
+</td><td>
+
+_(Optional)_ Library UUID, default is system library, you can use [LIB\_LibrariesList](./LIB_LibrariesList.md) APIs in
+
+</td></tr>
+<tr><td>
+
+classification
+
+</td><td>
+
+Array&lt;string&gt;
+
+</td><td>
+
+_(Optional)_ Classification, defaults to all
+
+</td></tr>
+<tr><td>
+
+simulationModelType
+
+</td><td>
+
+[ELIB\_SimulationModelType](../enums/ELIB_SimulationModelType.md)
+
+</td><td>
+
+_(Optional)_ Simulation model type, defaults to all
+
+</td></tr>
+<tr><td>
+
+itemsOfPage
+
+</td><td>
+
+number
+
+</td><td>
+
+_(Optional)_ Number of search results per page
+
+</td></tr>
+<tr><td>
+
+page
+
+</td><td>
+
+number
+
+</td><td>
+
+_(Optional)_ Page count
+
+</td></tr>
+</tbody></table>
+
+## Returns
+
+Promise&lt;Array&lt;[ILIB\_SimulationModelSearchItem](../interfaces/ILIB_SimulationModelSearchItem.md)<!-- -->&gt;&gt;
+
+List of searched simulation model properties
+
+## Remarks
+
+ADD since EDA v3.2.167
+
+## Example
+
+```javascript
+// 1. 按空关键字列出系统库中的仿真模型，每页 5 条，只看 Ngspice 类型（换成 '2N3904' 等关键字即为按名称过滤）
+const results = await eda.lib_SimulationModel.search('', undefined, undefined, 'Ngspice', 5, 1);
+
+// 2. 输出搜索结果
+console.log('count:', results.length);
+results.forEach((item, i) => {
+	console.log(`[${i}] name:`, item.name, 'uuid:', item.uuid, 'libraryUuid:', item.libraryUuid);
+});
+```