ANSYS WB二次开发专栏文章索引

利用好帮助，可以事半功倍，本人介绍下如何使用SpaceClaim中的帮助文档。

1、什么是API?

API，可翻译为应用程序编程接口，通过API，开发人员可与软件进行交互，从而扩展其功能及自动化特定任务。通俗来讲，可理解为访问和操作软件内部对象的已经提前封装好的各种类和函数。SC中的API函数默认通过.NET语言，如C#语言来进行编写脚本，故而其API用法的帮助也是基于NET语言格式。对于Python脚本来讲，无直接基于Python语法格式的帮助介绍，只能借助于现有的帮助进行理解。因而，使用好API的帮助对于后期我们编写脚本代码具有非常大的好处，这是每个学员必须掌握的内容。

2、API使用要点：

API函数命名规则：基于驼峰法进行命名，也即每个单词的首写字母均大写
API函数的引用：API函数的引用均采用点号法来进行引用，例如创建一个二维关键点，首先引用Point2D这个类，然后在使用这个类下面的Create方法，总的用法就是 Create
API使用中如果需要调用返回值，则可以用RE=的形式使用，如果不需要调用返回值，则直接采用命令即可。函数的返回值一般是指新建的对象，如果没有创建新对象，则返回值为空，例如体与体的相交能产生新的体，有具体的返回值，但体与体的融合由于没有产生新的对象，故返回值为空。如何查询一个API有没有返回值要通过帮助中的Return Value进行查看，如下所示。
同一种功能可能有多个API可以实现，掌握自己常用的即可，本教程也是讲解比较常见的API函数

3、API帮助的使用

API的帮助使用方法每个学员必须掌握，这对于后期单独写脚本代码非常有用，这里的API帮助其实类似于经典APDL中的Help，通过API帮助文档，我们可以了解每个API的功能以及使用方法。

SC的API帮助位置如下：

ANSYS安装位置\ANSYS Inc\v231\SCDM\SpaceClaim.Api.V23，不同版本的API帮助文件不一样，建议以实际开发中的版本为准。打开相应文件夹后用户只需查看API _Combined_Class_Library即可，打开方式选择HTML 帮助可执行文件。

打开帮助后，切换到目录，可看到其包含14个命名空间，也即NameSpace,每个命名空间下面包括了不同的API使用说明。

每一个大的NameSpace总的说来包含如下几种类型：

Classes、Structures:分别为C语言中的类和结构体，两者均为面向对象，定义和使用方法基本一致，不同在于两者在内存和性能方面的区别，对于用户而言，不必去了解API种类是类还是结构，只需知道如何使用即可。

Interfaces：对象接口实例化

Enumerations：枚举对象，也即该对象的可能值

下面重点介绍Classes的使用说明。

Classes或者Structure主要包含以下几个模块（不同的Class包含的模块可能不一样，有的模块有，有的没有，以软件帮助界面为准）：

Syntax: 表示该API的语法，语法是基于C语言阐述，用户可不了解

Constructors：构造函数，也即用以创建并初始化对象实例，通常和Class同名，用户只需输入相关参数即可。

Properties: 表示该API所指定对象可提取的属性，每种属性都有详细的描述，表达该属性的具体内容。

Methods: 表示该API所指对象可调用的操作方法，例如创建、删除等，每种对象后面的描述则表达该操作的效果，方法后面加了一个s的表达的是static对象(C#)，对于python用户来讲，无需区别

Methods的帮助里面，注意语法里面每个位置的参数名称以及类别，在Parameters下面有每个参数的类别，Return Value则表达的是该操作方法的返回对象，如下所示。

除了常规Methods外，有的Class还具有Extension Methods，这种一般是GUI中无法实现的操作，具体用法同常规Method.

Operators：运算，部分对象可以进行几何运算，例如布尔运算，特别要注意其输入的参数对象类别及返回值类别

Fields：一般出现于结果类型的API中，表达的是不同类型的成员组成，调用方法类似属性。

在编写脚本代码的时候，由于部分API名称记不住，一般是先通过GUI操作，并同时打开代码记录功能，了解每一步GUI操作所对应的API函数名称，然后在通过API帮助里面的索引功能查询每一个API所对应的属性，方法等，最后在修改代码。

为更加方便大家系统学习WB脚本知识及软件二次开发流程，水哥特推出《基于Python脚本ANSYS Workbench 软件二次开发专题教程》，本教程分为6篇，分别为Python语言基础知识篇、SpaceClaim脚本知识篇、Mechanical脚本知识篇、Workbench项目管理脚本知识篇、项目脚本调试篇以及项目软件二次开发篇，本套课程总计约100课时，平均每个课时30~50分钟，全套课程总计约 70小时，通过本教程，学员可系统性的掌握利用Python语言进行ansys workbench二次开发的相关技巧，课程详情请点击下方文章了解：