(完整)3_UG二次开发实用教程第三章.pdf
《(完整)3_UG二次开发实用教程第三章.pdf》由会员分享,可在线阅读,更多相关《(完整)3_UG二次开发实用教程第三章.pdf(16页珍藏版)》请在淘文阁 - 分享文档赚钱的网站上搜索。
1、第 3 章 编程基础 3.1 UG/Open API 函数 3.1.1 函数名称的约定 UG/Open API 共有两类名称约定。一个是标准的UG/Open API 的函数名称约定;另一个是以前版本原有的名称约定。1、标准名称约定 格式:UF_ 说明:UF_,user funciton的简写,表示该函数为UG/Open API函数;,应用或模块的名称缩写。例如 modl 和 disp 分别是Modeling模块和Display功能的名称缩写;,表示其实现功能的语言描述,一般由下划线分开的动词和名词(或词组)组成。常用的动词有:ask(查询)、create(创建)、edit(编辑)、set(设置
2、)、delete(删除)等。例如:UF_MODL_create_block1()为创建立方体的函数;UF_DISP_set_highlight()是高亮显示对象的函数;(2)非标准名称约定 格式:uc 和 uf 说明:代表UG/Open API C 程序,通常是四位数或三位数接一个字母。例如:uc1601是一个提示信息函数。3.1.2 函数参数的约定 UG/Open API 提供的函数遵守 ANSI/ISO C 的标准,并以下列格式在头文件中提供函数原型:(变量列表);返回数据类型通常是 C 数据类型或 UG/Open API 自定义数据类型。参数的输入输出方式有 3 种:I(Input)、O
3、(Output)或 OF(Output Free),说明见表 3-1。表 3-1 参数输入方式说明 元 素 描 述 I 表示参数为输入方式,参数在使用前必须赋值 O 表示参数为输出方式,使用前无须赋值 OF 表示参数为输出方式,且使用后需要释放内存。UG/Open API 提供的常用 释 放 内 存 函 数 有UF_free()、UF_free_string()和UF_STYLER_free_value()等,至于选择哪种释放函数需视具体情况而定。例如:函数 UF_PART_open()名称:UF_PART_open 使用环境:internal&external 语法格式:int UF_PAR
4、T_open(char*part_name,tag_t*part,UF_PART_load_status_t*error_status);描述:加载一个 UG 部件文件到 UG 的界面环境中,并把它设为工作和当前显示部件,该函数的描述见表3-2。表 3-2 函数 UF_PART_open()参数描述 参数 输入输出 类型 描述 part_name 输入 char*要打开的部件文件名 part 输出 tag_t*打开部件的标识,当打开部件文件失败时为 NULL_TAG error_status 输出 UF_PART_load_status_t*当加载部件失败时该结构中将包含错误代码和部件文件名称
5、,使用结 束后应使用函数UF_free_string_arry()和UF_free()释放内存 return 输出 int 返回代号:为 0 时表示正常;非 0 时表示错误代号 3.2 UG/Open API 的数据类型 除了 C 语言标准的数据类型外,UG/Open API 还提供了一些自定义的数据类型,如 tag_t 类型、结构类型(structure type)、枚举类型(enum type)、联合类型(union type)与指针类型(pointer type)等,它们统一用后缀“_t”表示,且这些数据类型的指针用反缀“_p_t”命名表示。数据类型约定如表 3-3 所示:表 3-3 数
6、据类型约定 后缀 描 述 _t 数据类型(data type)_p_t 数据类型的指针(pointer to data type)_s 结构标识(structure tag)_u_t 联合类型(union type)_u_p_t 联合类型的指针(pointer to a union type)_f_t 函数指针(pointer to a function)3.2.1 tag_t 类型 UG/Open API 使用最多的数据类型是 tag_t,在 UG/Open API 的uf_defs.h 中定义如下:typedef unsigned int tag_t,*tag_p_t;在 UG 环境中,t
7、ag_t 是 UG 对象的句柄,即 UG 对象模型的唯一标识。它是一种不重复的无符号整型数值,主要用于标识应用程序中的对象,如部件、草图、曲线、属性和表达式等。UG 应用程序只能访问句柄,而不能直接访问句柄所指示的实际对象。程序一般通过调用 API 函数获取句柄,并且在其他 API 函数中使用这个句柄,以引用它指示的对象。在此过程中,句柄的实际值对程序来说是无关紧要的。此外,tag_p_t 是指向tag_t数据类型的指针。以部件对象为例,下面的代码首先获取工作部件的tag_t值,然后获取该句柄所引用部件对象的文件名。tag_t tWorkPart;tWorkPart=UF_ASSEM_ask_
8、work_part();3.2.2 结构类型 UG/Open API 采用 C 语言的语法定义了一些常用的结构类型,将相应联系的不同类型数据封装在一起使用,这些结构类型用后缀“_s”表示,例如:struct UF_STYLER_item_value_type_s int reason;const char*item_id;int subitem_index;int count;int item_attr;int indicator;UF_STYLER_value_t value;typedef struct UF_STYLER_item_value_type_s UF_STYLER_item_
9、value_type_t,*UF_STYLER_item_value_type_p_t;结构体 UF_STYLER_item_value_type_s 封装了对话框控件的基本属性,如 reason、item_id 和 value 等。UG/Open API 使用关键词 typedef将该结构类型定义为新类型 UF_STYLER_item_value_type_t,用户可以使用它定义结构变量,然后引用结构体内的数据成员,例如:UF_STYLER_item_value_type_t data;UF_STYLER_ask_value(dialog_id,&data);UF_STYLER_free_v
10、alue(&data);3.2.3 枚举类型 枚举类型将变量的值一一列举出来,变量的值只限于列举出来的值的范围。UG/Open API 采用 C 语言的语法定义了一些常用的枚举类型,使用后缀“_e”表示。以枚举类型 UF_ASSEM_load_status_e 为例,下面给出其详细定义:enum UF_ASSEM_load_status_e UF_ASSEM_ok,UF_ASSEM_suppressed,UF_ASSEM_not_loaded,UF_ASSEM_instance_suppressed;typedef enum UF_ASSEM_load_status_e UF_ASSEM_lo
11、ad_status_t;枚举类型 UF_ASSEM_load_status_e 表示部件在装配体中的状态。UG/Open API 使 用 typedef 关 键 词 将 该 枚 举 类 型 定 义 为 新 类 型UF_ASSEM_load_status_t,例如:char sPartPath=“E:Examplepart.prt”;tag_t tPart=NULL_TAG;UF_PART_load_status_t error_status;UF_PART_open(sPartPath,&tPart,&error_status);3.2.4 联合类型 有时需要将不同数据类型的变量放在同一段内存
12、单元中,这种使不同变量占用同一段内存的结构类型称为联合类型。联合类型与结构类型的定义形式相似,但含义不同。联合类型变量所占的内存长度等于其内部最长数据成员的长度,而结构类型变量所占的内存长度则是其各数据成员所占内存长度之和。UG/Open API 采用 C 语言的语法定义了一些常用的联合类型,使用后缀“_u”表示。以联合类型 UF_STYLER_value_u 为例,下面给出其详细定义:union UF_STYLER_value_u char *string;char *strings;int integer;int *integers;double real;double *reals;UF
13、_UI_selection_p_t selection;UF_STYLER_notification_p_t notify;UF_UI_attachment_t attach;UF_UI_option_toggle_t option_toggle;typedef union UF_STYLER_value_u UF_STYLER_value_t;联合体 UF_STYLER_value_u 封装了对话框对话框控件的属性值,如string、integer 和 real 等。UG/Open API 使用 typedef 关键词将该联合类型定义为新类型UF_STYLER_value_t,它是UF_ST
14、YLER_item_value_type_t中的数据成员 value 的类型,例如:UF_STYLER_item_value_type_t data;double rValue;sel_data.item_id=REAL_BUTTOM_DIAMETER;UF_STYLER_ask_value(dialog_id,&sel_data);rValue =data.value.real;3.3 UG 对象类型及基本操作 UG 中的所有对象都是通过唯一的 tag_t 值进行标识,这些对象大致可以分为部件对象、UF 对象、表达式、链表和属性。3.3.1 部件对象 部件对象是 UG 最基本的操作对象之一,
15、不仅包含了零件的几何信息,而且更包含了大量的非几何信息,非几何信息包括:创建部件的计算机类型;保存部件的 UG 版本;部件的历史信息(例如部件文件的保存记录等);状态、描述和用户区的可永久保存在部件文件中的信息。UG/Open API 提供的访问和操作部件文件的函数包括部件文件的创建、打开、关闭、保存和信息的查询等。表 3-4 对部件对话操作的函数 函数 描述 UF_OBJ_cycle_objs_in_part()在部件中查询对象 UF_ATTR_ask_part_attrs()访问部件的属性 UF_PART_close()UF_PART_reopen()关闭和再打开部件 UF_PART_as
16、k_part_name()获取部件的文件名 UF_PART_ask_customer_area()UF_PART_ask_description()UF_PART_ask_status()查询其他信息,包括:查询用户定义的数据、部件文件的描述信息,部件文件的状态信息 UF_PART_ask_part_history()查询部件文件的历史 UF_PART_ask_compression_flags()UF_PART_set_compression_flags()查询及设置部件文件的压缩标记 部件对象基本操作涉及的函数主要有 UF_PART_new、UF_PART_open、UF_PART_clo
17、se_all、UF_PART_save 和 UF_PART_close。(1)UF_PART_new extern int UF_PART_new(char*part_name,int units,tag_t*part );参数 part_name 是指向保存被创建文件路径和名称的字符串指针,units 是输入参数,表示被创建文件使用的单位制,1 表示米制,0 表示英制。part 是输出参数,是指向新创建部件文件的 tag_t。该函数的返回值是错误代码,可以利用函数 UF_get_fail_message 得到其所对应的错误信息。(2)UF_PART_open extern int UF_PA
18、RT_open(char*part_name,tag_t*part,UF_PART_load_status_t*error_status );参数 part_name 是指向保存被创建文件路径和名称的字符串指针,是输入参数。error_status 是输出参数,表示打开文件的操作是否产生错误。(3)UF_PART_close_all extern int UF_PART_close_all()将当前会话中的所有部件文件关闭。对于被修改的部件文件,UF_PART_close_all并不会导致这些文件被存盘,也不会提示用户存盘。UG仅仅向用户确认是否将当前部件文件关闭。(4)UF_PART_sav
19、e extern int UF_PART_save()将当前会话中显示的部件文件存盘。由于UG 本身并不对部件文件自动存盘,所以存盘需求都需要户进行维护。(5)UF_PART_close extern int UF_PART_close(tag_t part,int scope,int mode )其中参数part是输入参数,表示关闭操作的部件的标识。参数scope是输入参数,表示被关闭文件涉及的范围。scope=1 表示关闭部件文件和其所有子装配;scope=0 表示仅仅关闭部件文件本身。参数 mode 是输入参数,表示是否请求用户确认。当 mode=0 时,如果被关闭的部件文件被修改过,则
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 完整 _UG 二次开发 实用教程 第三
限制150内