UF_CLEAR_ask_analysis_mode (查看源代码)
定义在: uf_clear.h
概述
Inquires the current clearance analysis mode. It may have one of the
following values: UF_CLEAR_QUICK_FACET, UF_CLEAR_FULL_FACET,
UF_CLEAR_BEST_AVAILABLE, UF_CLEAR_FACET_SOLID, or UF_CLEAR_SOLID.
返回
Return code:
0 = No error
not 0 = Error code, which includes
UF_CLEAR_err_bad_dataset.
环境
内部和外部
参见
需要许可证（S）
gateway （UG入口基本模块，Gateway是所有其它Uuigraphics模块的一个必要条件）
int UF_CLEAR_ask_analysis_mode
(
tag_t dataset,
int * analysis_mode
)
| tag_t （tag_t类型） | dataset | Input（输入） | The data set tag. |
| int * (整数型指针) | analysis_mode | Output（输出） | One of the following analysis modes:
UF_CLEAR_QUICK_FACET,
UF_CLEAR_FULL_FACET,
UF_CLEAR_BEST_AVAILABLE,
UF_CLEAR_FACET_SOLID, or
UF_CLEAR_SOLID. |
UF_CLEAR_ask_dataset_name (查看源代码)
定义在: uf_clear.h
概述
Gets the name of a clearance analysis dataset.
The name must be allocated to at least MAX_LINE_SIZE+1 characters.
返回
Return code:
0 = No error
not 0 = Error code, which includes
UF_CLEAR_err_bad_dataset.
环境
内部和外部
参见
需要许可证（S）
gateway （UG入口基本模块，Gateway是所有其它Uuigraphics模块的一个必要条件）
int UF_CLEAR_ask_dataset_name
(
tag_t dataset,
char * name
)
| tag_t （tag_t类型） | dataset | Input（输入） | The dataset tag. |
| char * (字符型指针) | name | Output（输出） | The name of the dataset. Must be allocated to
MAX_LINE_SIZE+1 characters. |
UF_CLEAR_ask_dataset_version (查看源代码)
定义在: uf_clear.h
概述
Gets the version of a clearance analysis dataset. The version indicates
how many times clearance analysis has been run on a data set. If the
version is zero, then the analysis has never been run.
返回
Return code:
0 = No error
not 0 = Error code, which includes
UF_CLEAR_err_bad_dataset.
环境
内部和外部
参见
需要许可证（S）
gateway （UG入口基本模块，Gateway是所有其它Uuigraphics模块的一个必要条件）
int UF_CLEAR_ask_dataset_version
(
tag_t dataset,
int * version
)
| tag_t （tag_t类型） | dataset | Input（输入） | The dataset tag. |
| int * (整数型指针) | version | Output（输出） | The version of dataset. |
UF_CLEAR_ask_default_clear_zone (查看源代码)
定义在: uf_clear.h
概述
Inquire the default clearance zone for the given data set. This routine
returns the clearance zone expression tag. If no expression has ever
been set, NULL_TAG is returned. Interpret its value as 0.0. For a
non-null expression, call UF_MODL_ask_exp_tag_value to get the
value of the expression.
返回
Return code:
0 = No error
not 0 = Error code, which includes
UF_CLEAR_err_bad_dataset.
环境
内部和外部
参见
需要许可证（S）
gateway （UG入口基本模块，Gateway是所有其它Uuigraphics模块的一个必要条件）
int UF_CLEAR_ask_default_clear_zone
(
tag_t dataset,
tag_t * def_clr_zone
)
UF_CLEAR_ask_exclude_rules (查看源代码)
定义在: uf_clear.h
概述
Enquires the global exclusion rules. These settings cause classes of
object pairs to be excluded from analysis: pairs composed of two
objects that belong to mated components, pairs belonging to the same
sub-assembly/component, pairs belonging to the same part and pairs
belonging to the same group.
返回
Return code:
0 = No error
not 0 = Error code, which includes
UF_CLEAR_err_bad_dataset.
环境
内部和外部
需要许可证（S）
gateway （UG入口基本模块，Gateway是所有其它Uuigraphics模块的一个必要条件）
int UF_CLEAR_ask_exclude_rules
(
tag_t dataset,
int * exclude_rules
)
| tag_t （tag_t类型） | dataset | Input（输入） | The dataset tag. |
| int * (整数型指针) | exclude_rules | Output（输出） | The exclusion rules that were applied. Any of the
following constants can be ORed together:
UF_CLEAR_EXCLUDE_MATING_PAIRS
UF_CLEAR_EXCLUDE_WITHIN_COMP
UF_CLEAR_EXCLUDE_WITHIN_PART
UF_CLEAR_EXCLUDE_WITHIN_GROUP |
UF_CLEAR_ask_interf_data (查看源代码)
定义在: uf_clear.h
概述
Inquires the data associated with a given pair of interfering objects.
The structure that is returned contains the type of interference. The
interference type is one of:
UF_CLEAR_SOFT_INTERFERENCE,
UF_CLEAR_TOUCH_INTERFERENCE,
UF_CLEAR_HARD_INTERFERENCE,
UF_CLEAR_CONT_1_IN_2_INTERFERENCE,
UF_CLEAR_CONT_2_IN_1_INTERFERENCE, or
UF_CLEAR_NO_INTERFERENCE.
If the interference was computed during the most recent analysis run,
the new_interference will be TRUE. The array of interference bodies
that are associated with the interference are passed back in the
interf_bodies field. n_bodies indicates the size of this array. This array
of tags could refer to points, lines, curves, and/or solid bodies,
depending on the analysis mode and the type of interference. If
n_bodies is greater than 0, this array must be freed using UF_free by
the caller when no longer needed. point1 and point2 indicate points
(in assembly coordinates) on both of the interfering objects. The text
field contains any text the user has associated with this interference.
interf_num is a unique number associated with each interference. You
may choose to sort interference based on this value. If the two objects
do not have a stored interference, then zero is returned for the
interference number, UF_CLEAR_NO_INTERFERENCE is returned as
the type, and the size of the interf_bodies array is zero.
返回
Return code:
0 = No error
not 0 = Error code, which includes
UF_CLEAR_err_bad_dataset
UF_CLEAR_err_bad_interf.
环境
内部和外部
参见
需要许可证（S）
gateway （UG入口基本模块，Gateway是所有其它Uuigraphics模块的一个必要条件）
int UF_CLEAR_ask_interf_data
(
tag_t dataset,
tag_t object1,
tag_t object2,
UF_CLEAR_interf_data_t * interf_data
)
UF_CLEAR_ask_next_dataset (查看源代码)
定义在: uf_clear.h
概述
Cycles all clearance analysis datasets in a part, beginning with NULL_TAG
as the the input set. NULL_TAG will be passed back to signify the end of
cycling.
Note: The dataset tag may only be used as a parameter to other UF_CLEAR
functions.
Note: Do not delete a dataset while it is being cycled.
返回
Return code:
0 = No error
not 0 = Error code, which includes
UF_CLEAR_err_bad_dataset.
环境
内部和外部
参见
需要许可证（S）
gateway （UG入口基本模块，Gateway是所有其它Uuigraphics模块的一个必要条件）
int UF_CLEAR_ask_next_dataset
(
tag_t part_tag,
tag_t * dataset
)
| tag_t （tag_t类型） | part_tag | Input（输入） | The part in which to find the dataset. |
| tag_t * (tag_t型的指针) | dataset | Input / Output | On input, the current dataset.
On output, the next dataset. |
UF_CLEAR_ask_next_interf (查看源代码)
定义在: uf_clear.h
概述
Cycles the interference in a clearance analysis data set. Interferences
are stored as object pairs. Start the cycling using NULL_TAG as the
input values for both object1 and object2. This routine passes back the
tags of the objects that define the next interference. NULL_TAG
returned for either object indicates the end of the cycling.
NOTE: The object tags that are passed back may refer to unloaded
objects. One or both of these objects could be object occurrences that
refer to unloaded prototypes. Before using these tags for any purpose
(other than cycling interferences) you must verify that the objects
refer to loaded objects.
返回
Return code:
0 = No error
not 0 = Error code, which includes
UF_CLEAR_err_bad_dataset
UF_CLEAR_err_bad_interf.
环境
内部和外部
参见
需要许可证（S）
gateway （UG入口基本模块，Gateway是所有其它Uuigraphics模块的一个必要条件）
int UF_CLEAR_ask_next_interf
(
tag_t dataset,
tag_t * object1,
tag_t * object2
)
UF_CLEAR_ask_num_lists (查看源代码)
定义在: uf_clear.h
概述
Inquire the number of object lists used by the given clearance analysis
data set. The number of lists can either be 1 or 2.
返回
Return code:
0 = No error
not 0 = Error code, which includes
UF_CLEAR_err_bad_dataset.
环境
内部和外部
参见
需要许可证（S）
gateway （UG入口基本模块，Gateway是所有其它Uuigraphics模块的一个必要条件）
int UF_CLEAR_ask_num_lists
(
tag_t dataset,
int * num_lists
)
| tag_t （tag_t类型） | dataset | Input（输入） | The dataset tag. |
| int * (整数型指针) | num_lists | Output（输出） | The number of lists used (1 or 2). |
UF_CLEAR_ask_obj_all_but_list (查看源代码)
定义在: uf_clear.h
概述
Returns a list of objects that was last selected to be excluded from
which_list, regardless of the current list type. If an object on the list is
currently not loaded, a NULL_TAG is put in its place in the
tag_array. You need to free the tag_array when no longer needed.
返回
Return code:
0 = No error
not 0 = Error code, which includes
UF_CLEAR_err_bad_dataset and
UF_CLEAR_err_bad_list_num.
环境
内部和外部
参见
需要许可证（S）
gateway （UG入口基本模块，Gateway是所有其它Uuigraphics模块的一个必要条件）
int UF_CLEAR_ask_obj_all_but_list
(
tag_t dataset,
int which_list,
int * list_size,
tag_t * * tag_array
)
| tag_t （tag_t类型） | dataset | Input（输入） | The dataset tag |
| int (整数型) | which_list | Input（输入） | Determines which list to use:
1 = List 1
2 = List 2 |
| int * (整数型指针) | list_size | Output（输出） | The number of objects in the list |
| tag_t * * | tag_array | Output to be freed
输出并释放 | The array of objects (solid or facet) on the list.
This should be freed by calling UF_free. |
UF_CLEAR_ask_obj_list (查看源代码)
定义在: uf_clear.h
概述
Inquires data associated with one of the clearance analysis object lists,
specified by which_list. The list_type corresponds to the ways the
object lists can be defined in the interactive application by using one
of these values: UF_CLEAR_ALL_OBJECTS, UF_CLEAR_ALL_VISIBLE_OBJECTS,
UF_CLEAR_ALL_BUT, or UF_CLEAR_FIXED_LIST.
If the data set only uses one list and which_list is 2, then list_type is
set to UF_CLEAR_LIST2_NOT_USED. The list is evaluated when
necessary and the number of objects in the list is returned in list_size.
A pointer to a tag_array is returned.
If list_size is greater than zero, you must call UF_free when you no
longer need this array. The tag_array stores either solid body or facet
model tags depending on which objects are currently loaded. If both
are loaded, the solid body tags are returned. If neither object is
loaded, then NULL_TAG is placed in the array.
返回
Return code:
0 = No error
not 0 = Error code, which includes
UF_CLEAR_err_bad_dataset
UF_CLEAR_err_bad_list_num.
环境
内部和外部
参见
需要许可证（S）
gateway （UG入口基本模块，Gateway是所有其它Uuigraphics模块的一个必要条件）
int UF_CLEAR_ask_obj_list
(
tag_t dataset,
int which_list,
int * list_type,
int * list_size,
tag_t * * tag_array
)
| tag_t （tag_t类型） | dataset | Input（输入） | The dataset tag. |
| int (整数型) | which_list | Input（输入） | Is this for list 1 or list 2?
Acceptable values are 1 and 2. |
| int * (整数型指针) | list_type | Output（输出） | The type of list (UF_CLEAR_ALL_OBJECTS,
UF_CLEAR_ALL_VISIBLE_OBJECTS,
UF_CLEAR_ALL_BUT,
UF_CLEAR_FIXED_LIST, or
UF_CLEAR_LIST2_NOT_USED). |
| int * (整数型指针) | list_size | Output（输出） | The number of objects in list. |
| tag_t * * | tag_array | Output to be freed
输出并释放 | The pointer to an array of objects (solids or facets)
on the list. This should be freed by calling UF_free. |
UF_CLEAR_ask_object_clear_zone (查看源代码)
定义在: uf_clear.h
概述
Inquire the clearance zone assigned to a given object. The object must be
a member of the dataset. The tag of the expression is returned. If no
expression has ever been set, the part of the given object is checked for
a clearance zone expression, if none is found, NULL_TAG will be returned
for clr_zone. Interpret its value as 0.0 (this is the default value). For a
non-null expression, call UF_MODL_ask_exp_tag_value to get its value. The
source parameter tells where the clearance zone comes from.
UF_CLEAR_USING_DEFINED_CZ specifies that the object has its own clearance
zone. UF_CLEAR_USING_DEFAULT_CZ means the default clearance zone is used.
返回
Return code:
0 = No error
not 0 = Error code, which includes
UF_CLEAR_err_bad_dataset
环境
内部和外部
参见
需要许可证（S）
gateway （UG入口基本模块，Gateway是所有其它Uuigraphics模块的一个必要条件）
int UF_CLEAR_ask_object_clear_zone
(
tag_t dataset,
tag_t object,
tag_t * clr_zone,
int * source
)
| tag_t （tag_t类型） | dataset | Input（输入） | The dataset tag. |
| tag_t （tag_t类型） | object | Input（输入） | The object (solid or facet) whose clearance zone is
requested. |
| tag_t * (tag_t型的指针) | clr_zone | Output（输出） | The clearance zone expression. |
| int * (整数型指针) | source | Output（输出） | The source of the clearance zone (one of
UF_CLEAR_USING_DEFINED_CZ, or
UF_CLEAR_USING_DEFAULT_CZ). |
UF_CLEAR_ask_pair_clear_zone (查看源代码)
定义在: uf_clear.h
概述
Inquire the clearance zone for a specific pair of objects. Both objects
must be members of the given dataset. The tag of the expression is
returned. If no expression has ever been set, NULL_TAG will be returned
for clr_zone. Interpret its value as 0.0 (this is the default value). For
a non-null expression, call UF_MODL_ask_exp_tag_value to get its value.
The source parameter tells where the clearance zone comes from. The
clearance zone could be the greater of the zones from object 1 or 2
(UF_CLEAR_USING_OBJ1_CZ or UF_CLEAR_USING_OBJ2_CZ).
UF_CLEAR_USING_PAIR_CZ means this pair has its own explicit clearance zone.
UF_CLEAR_USING_DEFAULT_CZ means the default clearance zone is used.
返回
Return code:
0 = No error
not 0 = Error code, which includes
UF_CLEAR_err_bad_dataset
环境
内部和外部
参见
需要许可证（S）
gateway （UG入口基本模块，Gateway是所有其它Uuigraphics模块的一个必要条件）
int UF_CLEAR_ask_pair_clear_zone
(
tag_t dataset,
tag_t object1,
tag_t object2,
tag_t * clr_zone,
int * source
)
| tag_t （tag_t类型） | dataset | Input（输入） | The dataset tag. |
| tag_t （tag_t类型） | object1 | Input（输入） | The first object (solid or facet) in the pair. |
| tag_t （tag_t类型） | object2 | Input（输入） | The second object (solid or facet) in the pair. |
| tag_t * (tag_t型的指针) | clr_zone | Output（输出） | The clearance zone expression. |
| int * (整数型指针) | source | Output（输出） | The source of the clearance zone (one of
UF_CLEAR_USING_OBJ1_CZ,
UF_CLEAR_USING_OBJ2_CZ,
UF_CLEAR_USING_PAIR_CZ, or
UF_CLEAR_USING_DEFAULT_CZ). |
UF_CLEAR_ask_preferences (查看源代码)
定义在: uf_clear.h
概述
Inquire clearance module preferences. The structure contains the
current interactive message filter, which indicates the types of
interferences that are displayed by the interactive analysis and review
functions. Each bit of this integer refers to a specific type of
interference (UF_CLEAR_SOFT_INTERFERENCE, etc.). Use the
appropriate C bitwise logical operators (&, |, and ^) to interpret this
value. The save_interference parameter indicates if the interference
bodies are saved during analysis. The current layer and color
assignments are returned. The current attention colors for
interferences and the parent objects is also given. These colors are
used in the interactive review of analysis results.
返回
Return code:
0 = No error
not 0 = Error code, which includes
UF_CLEAR_err_bad_dataset.
环境
内部和外部
参见
需要许可证（S）
gateway （UG入口基本模块，Gateway是所有其它Uuigraphics模块的一个必要条件）
int UF_CLEAR_ask_preferences
(
tag_t dataset,
UF_CLEAR_pref_t * preferences
)
UF_CLEAR_ask_results (查看源代码)
定义在: uf_clear.h
概述
Inquires a summary of the results of the most recent clearance
analysis run. The UF_CLEAR_summary_t structure is filled with
analysis statistics, including numbers of objects, number of pairs,
number of checked pairs, and number of interferences of each type. If
clearance analysis has never been run on the data set, an error is
returned.
返回
Return code:
0 = No error
not 0 = Error code, which includes
UF_CLEAR_err_bad_dataset
UF_CLEAR_err_no_results.
环境
内部和外部
参见
需要许可证（S）
gateway （UG入口基本模块，Gateway是所有其它Uuigraphics模块的一个必要条件）
int UF_CLEAR_ask_results
(
tag_t dataset,
UF_CLEAR_summary_t * summary
)
UF_CLEAR_copy_dataset (查看源代码)
定义在: uf_clear.h
概述
Makes a copy of a dataset. You must supply a unique name. There are three
modes in which to copy the dataset: UF_CLEAR_COPY_NO_RESULTS only copies
the setup data. The version of the new dataset is set to zero (meaning
clearance analysis has not been run); UF_CLEAR_COPY_RESULTS makes a copy of
the current analysis results, but not the interference bodies;
UF_CLEAR_COPY_INTERF_BODIES makes a complete copy of the results. The name
must be less than MAX_LINE_SIZE characters long.
NOTE: The new data set tag may only be used as a parameter to
other UF_CLEAR functions.
返回
Return code:
0 = No error
not 0 = Error code, which includes
UF_CLEAR_err_bad_dataset
UF_CLEAR_err_name_exists
UF_CLEAR_err_bad_string
UF_CLEAR_err_bad_copy_mode.
环境
内部和外部
参见
需要许可证（S）
assemblies
int UF_CLEAR_copy_dataset
(
tag_t dataset,
char * name,
int mode,
tag_t * new_dataset
)
| tag_t （tag_t类型） | dataset | Input（输入） | The dataset to copy. |
| char * (字符型指针) | name | Input（输入） | The name of the new dataset. |
| int (整数型) | mode | Input（输入） | Copy mode, see above. |
| tag_t * (tag_t型的指针) | new_dataset | Output（输出） | The dataset that is copied. |
UF_CLEAR_count_datasets (查看源代码)
定义在: uf_clear.h
概述
Determines the number of clearance analysis datasets in the specified part.
返回
Return code:
0 = No error
not 0 = Error code, which includes
UF_CLEAR_err_bad_part.
环境
Internal & External
参见
需要许可证（S）
assemblies
int UF_CLEAR_count_datasets
(
tag_t part_tag,
int * num
)
| tag_t （tag_t类型） | part_tag | Input（输入） | The part in which to count. |
| int * (整数型指针) | num | Output（输出） | The number of datasets. |
UF_CLEAR_count_interferences (查看源代码)
定义在: uf_clear.h
概述
Inquires the number of interferences stored in a clearance analysis
data set. If clearance analysis has never been run on the data set, an
error is returned.
返回
Return code:
0 = No error
not 0 = Error code, which includes
UF_CLEAR_err_bad_dataset.
环境
内部和外部
参见
需要许可证（S）
assemblies
int UF_CLEAR_count_interferences
(
tag_t dataset,
int * num_interf
)
| tag_t （tag_t类型） | dataset | Input（输入） | The data set tag. |
| int * (整数型指针) | num_interf | Output（输出） | The number of interferences associated with the
dataset. |
UF_CLEAR_create_dataset (查看源代码)
定义在: uf_clear.h
概述
Creates a new clearance analysis data set, initialized to default values.
If successful, this routine returns the tag of the new dataset. If a
dataset of the given name already exists, an error is returned. The
name must be less than MAX_LINE_SIZE characters long.
NOTE: The new data set tag may only be used as a parameter to
other UF_CLEAR functions.
返回
Return code:
0 = No error
not 0 = Error code, which includes
UF_CLEAR_bad_part
UF_CLEAR_err_name_exists
UF_CLEAR_err_bad_string.
环境
内部和外部
参见
需要许可证（S）
assemblies
int UF_CLEAR_create_dataset
(
tag_t part_tag,
char * name,
tag_t * dataset
)
| tag_t （tag_t类型） | part_tag | Input（输入） | The part in which the new dataset belongs. |
| char * (字符型指针) | name | Input（输入） | The name of the new dataset. |
| tag_t * (tag_t型的指针) | dataset | Output（输出） | The new dataset tag. |
UF_CLEAR_delete_all (查看源代码)
定义在: uf_clear.h
概述
Deletes all clearance analysis data from the given part, including all
clearance analysis data sets, analysis results, and interference bodies.
返回
Return code:
0 = No error
not 0 = Error code, which includes:
UF_CLEAR_bad_part.
环境
内部和外部
参见
需要许可证（S）
assemblies
int UF_CLEAR_delete_all
(
tag_t part_tag
)
| tag_t （tag_t类型） | part_tag | Input（输入） | The part from which all clearance analysis data is to
be deleted. |
UF_CLEAR_delete_dataset (查看源代码)
定义在: uf_clear.h
概述
Delete the given clearance analysis data set.
NOTE: Do not delete data sets while they are being cycled.
返回
Return code:
0 = No error
not 0 = Error code, which includes
UF_CLEAR_err_bad_dataset.
环境
内部和外部
参见
需要许可证（S）
assemblies
int UF_CLEAR_delete_dataset
(
tag_t dataset
)
UF_CLEAR_delete_interf (查看源代码)
定义在: uf_clear.h
概述
Deletes the interference for a given object pair. Both objects must be
members of the given data set. If the object pair does not refer to an
existing interference, an error is returned. All data associated with the
interference is deleted.
NOTE: It is acceptable to delete the interference bodies without
deleting the interference itself. Use the normal deletion functions to
delete the interference points, lines, curve, and/or solid bodies. By
doing so, all interference data is retained except for the bodies
themselves. This might be desirable in cases where the interference
bodies make the part file unnecessarily large.
返回
Return code:
0 = No error
not 0 = Error code, which includes
UF_CLEAR_err_bad_dataset
UF_CLEAR_err_bad_interf.
环境
内部和外部
参见
需要许可证（S）
assemblies
int UF_CLEAR_delete_interf
(
tag_t dataset,
tag_t object1,
tag_t object2
)
UF_CLEAR_do_clearance_analysis (查看源代码)
定义在: uf_clear.h
概述
Performs clearance analysis on the given dataset using the previously
set options. This function looks at all object pairs from the objects
lists. All object pairs that are not excluded and have changed since the
last analysis run are analyzed. Facet models are created when
necessary if using one of the facet analysis modes. Interference results
are created using previously set options. This function can not be
gracefully interrupted and interferences are not reported as they are
found.
返回
Return code:
0 = No error
not 0 = Error code, which includes:
UF_CLEAR_err_bad_dataset
UF_CLEAR_err_analysis_error
UF_CLEAR_err_facet_error
UF_CLEAR_err_obj_not_avail.
环境
内部和外部
需要许可证（S）
assemblies
int UF_CLEAR_do_clearance_analysis
(
tag_t dataset
)
UF_CLEAR_find_dataset (查看源代码)
定义在: uf_clear.h
概述
Finds the tag of a named clearance analysis data set. If the name
doesn't exist, UF_CLEAR_err_cant_find_dataset is returned. The
name must be equal to or less than MAX_LINE_SIZE characters long.
NOTE: The data set tag may only be used as a parameter to other
UF_CLEAR functions.
返回
Return code:
0 = No error
not 0 = Error code, which includes
UF_CLEAR_err_bad_part
UF_CLEAR_err_bad_string
UF_CLEAR_err_cant_find_dataset.
环境
内部和外部
参见
需要许可证（S）
assemblies
int UF_CLEAR_find_dataset
(
tag_t part_tag,
char * name,
tag_t * dataset
)
| tag_t （tag_t类型） | part_tag | Input（输入） | The part in which to search. |
| char * (字符型指针) | name | Input（输入） | The name of the dataset to search for. |
| tag_t * (tag_t型的指针) | dataset | Output（输出） | The tag of the found dataset. |
UF_CLEAR_is_pair_changed (查看源代码)
定义在: uf_clear.h
概述
Inquires if an object pair has changed since the last analysis run. Both
objects must be solid bodies or facet models that are members of the
clearance analysis data set. If either object has changed since the last
analysis run, then is_changed is returned as TRUE. If no analysis has
been run on either of the objects, TRUE is returned.
返回
Return code:
0 = No error
not 0 = Error code, which includes
UF_CLEAR_err_bad_dataset
环境
内部和外部
参见
需要许可证（S）
gateway （UG入口基本模块，Gateway是所有其它Uuigraphics模块的一个必要条件）
int UF_CLEAR_is_pair_changed
(
tag_t dataset,
tag_t object1,
tag_t object2,
logical * is_changed
)
| tag_t （tag_t类型） | dataset | Input（输入） | The dataset tag. |
| tag_t （tag_t类型） | object1 | Input（输入） | The first object (solid or facet) in the pair. |
| tag_t （tag_t类型） | object2 | Input（输入） | The second object (solid or facet) in the pair. |
| logical * | is_changed | Output（输出） | Has this pair changed since the last analysis run? |
UF_CLEAR_is_pair_included (查看源代码)
定义在: uf_clear.h
概述
Inquires if an object pair is to be included in the analysis. Both objects
must be solid bodies or facet models that are members of the
clearance analysis data set. If the pair is to be analyzed, the include_it
is returned as TRUE. The reason parameter signifies why the pair is
included or excluded. UF_CLEAR_EXCL_NO_REASON is returned
when the default behavior is applied.
UF_CLEAR_EXCL_USER_DEF means the user has explicitly
included or excluded this pair. UF_CLEAR_EXCL_SAME_COMP,
UF_CLEAR_EXCL_SAME_PART, UF_CLEAR_EXCL_SAME_GROUP, and
UF_CLEAR_EXCL_MATED_COMP are returned if one of the
global exclusion rules applied to this pair. Only one such rule is
returned, even if several such rules apply to the given pair.
返回
Return code:
0 = No error
not 0 = Error code, which includes
UF_CLEAR_err_bad_dataset
环境
内部和外部
参见
需要许可证（S）
gateway （UG入口基本模块，Gateway是所有其它Uuigraphics模块的一个必要条件）
int UF_CLEAR_is_pair_included
(
tag_t dataset,
tag_t object1,
tag_t object2,
logical * include_it,
int * reason,
char * * text
)
| tag_t （tag_t类型） | dataset | Input（输入） | The dataset tag. |
| tag_t （tag_t类型） | object1 | Input（输入） | The first object (solid or facet) in the pair. |
| tag_t （tag_t类型） | object2 | Input（输入） | The second object (solid or facet) in the pair. |
| logical * | include_it | Output（输出） | Should this pair be included in the analysis? |
| int * (整数型指针) | reason | Output（输出） | The reason the pair is included or excluded (one of
UF_CLEAR_EXCL_NO_REASON,
UF_CLEAR_EXCL_USER_DEF,
UF_CLEAR_EXCL_SAME_COMP,
UF_CLEAR_EXCL_SAME_PART,
UF_CLEAR_EXCL_SAME_GROUP, or
UF_CLEAR_EXCL_MATED_COMP). |
| char * * | text | Output to be freed
输出并释放 | The text associated with
UF_CLEAR_set_pair_inclusion and
UF_CLEAR_set_pair_exclusion when reason is
UF_CLEAR_EXCL_USER_DEF, or an empty
string is returned. Use UF_free((void ) text) to
deallocate memory when done. |
UF_CLEAR_rename_dataset (查看源代码)
定义在: uf_clear.h
概述
Changes the name of the given data set. If a dataset of the given name
already exists, an error is returned. The name must be equal to or less
than MAX_LINE_SIZE characters long.
返回
Return code:
0 = No error
not 0 = Error code, which includes
UF_CLEAR_err_bad_dataset
UF_CLEAR_err_name_exists
UF_CLEAR_err_bad_string.
环境
内部和外部
参见
需要许可证（S）
assemblies
int UF_CLEAR_rename_dataset
(
tag_t dataset,
char * name
)
| tag_t （tag_t类型） | dataset | Input（输入） | The dataset to rename. |
| char * (字符型指针) | name | Input（输入） | The new name. |
UF_CLEAR_set_analysis_mode (查看源代码)
定义在: uf_clear.h
概述
Sets the clearance analysis mode. It may have one of the following
values: UF_CLEAR_QUICK_FACET, UF_CLEAR_FULL_FACET,
UF_CLEAR_BEST_AVAILABLE, UF_CLEAR_FACET_SOLID, or UF_CLEAR_SOLID.
返回
Return code:
0 = No error
not 0 = Error code, which includes
UF_CLEAR_err_bad_analysis_mode,
UF_CLEAR_err_bad_dataset.
环境
内部和外部
参见
需要许可证（S）
assemblies
int UF_CLEAR_set_analysis_mode
(
tag_t dataset,
int analysis_mode
)
| tag_t （tag_t类型） | dataset | Input（输入） | The data set tag. |
| int (整数型) | analysis_mode | Input（输入） | One of the following analysis modes:
UF_CLEAR_QUICK_FACET,
UF_CLEAR_FULL_FACET,
UF_CLEAR_BEST_AVAILABLE,
UF_CLEAR_FACET_SOLID, or
UF_CLEAR_SOLID. |
UF_CLEAR_set_default_clear_zone (查看源代码)
定义在: uf_clear.h
概述
Sets the default clearance zone for the given data set. During analysis,
any object pair that doesn't have either a zone for one of its objects or
for the pair, explicitly uses this default clearance zone. You must
supply the tag of a valid expression.
返回
Return code:
0 = No error
not 0 = Error code, which includes
UF_CLEAR_err_bad_dataset
UF_CLEAR_err_bad_expression.
环境
内部和外部
参见
需要许可证（S）
assemblies
int UF_CLEAR_set_default_clear_zone
(
tag_t dataset,
tag_t def_clr_zone
)
UF_CLEAR_set_exclude_rules (查看源代码)
定义在: uf_clear.h
概述
Sets the global exclusion rules. These settings causes classes of object
pairs to be excluded from analysis: pairs composed of two objects that
belong to mated components; pairs belonging to the same sub-assembly/
component; pairs belonging to the same part; and pairs belonging to the
same group. The exclude_rules value can be comprised of zero or more of
the following constants ORed together: UF_CLEAR_EXCLUDE_MATING_PAIRS,
UF_CLEAR_EXCLUDE_WITHIN_COMP, UF_CLEAR_EXCLUDE_WITHIN_PART and
UF_CLEAR_EXCLUDE_WITHIN_GROUP. The default value is to exclude nothing,
i.e., exclude_rules = 0. The customer default file can also be used
to change this default value. See the default values for,
Assemblies_ClrAnlExclMatingPairs, Assemblies_ClrAnlExclWithinComp,
Assemblies_ClrAnlExclWithinPart and Assemblies_ClrAnlExclWithinGroup.
返回
Return code:
0 = No error
not 0 = Error code, which includes
UF_CLEAR_err_bad_dataset
UF_CLEAR_err_bad_exclude_rule.
环境
内部和外部
参见
需要许可证（S）
assemblies
int UF_CLEAR_set_exclude_rules
(
tag_t dataset,
int exclude_rules
)
| tag_t （tag_t类型） | dataset | Input（输入） | The data set tag. |
| int (整数型) | exclude_rules | Input（输入） | Which rules should be applied? The following
constants can be ORed together:
UF_CLEAR_EXCLUDE_MATING_PAIRS,
UF_CLEAR_EXCLUDE_WITHIN_COMP,
UF_CLEAR_EXCLUDE_WITHIN_PART,
and UF_CLEAR_EXCLUDE_WITHIN_GROUP. |
UF_CLEAR_set_interf_text (查看源代码)
定义在: uf_clear.h
概述
Associates a text string to an interfering object pair. Both objects must
be members of the given dataset. If the object pair does not refer to
an existing interference, an error is returned.
返回
Return code:
0 = No error
not 0 = Error code, which includes
UF_CLEAR_err_bad_dataset,
UF_CLEAR_err_bad_interf.
环境
内部和外部
需要许可证（S）
assemblies
int UF_CLEAR_set_interf_text
(
tag_t dataset,
tag_t object1,
tag_t object2,
char * text
)
| tag_t （tag_t类型） | dataset | Input（输入） | The dataset tag |
| tag_t （tag_t类型） | object1 | Input（输入） | The first object (solid or facet) in the pair |
| tag_t （tag_t类型） | object2 | Input（输入） | The second object (solid or facet) in the pair |
| char * (字符型指针) | text | Input（输入） | The text to associate with the interference. The
length of the text cannot be greater than the value
assigned to the string constant MAX_LINE_SIZE. |
UF_CLEAR_set_obj_list (查看源代码)
定义在: uf_clear.h
概述
Fully defines a clearance analysis object list, specified by which_list.
The list type corresponds to the ways an object list can be defined in
the interactive application by using one of these values:
UF_CLEAR_ALL_OBJECTS, UF_CLEAR_ALL_VISIBLE_OBJECTS, UF_CLEAR_ALL_BUT, or
UF_CLEAR_FIXED_LIST.
To specify a one list data set, set which_list to 2 and list_type to
UF_CLEAR_LIST2_NOT_USED. No tag_array is necessary.
For a UF_CLEAR_ALL_OBJECTS or UF_CLEAR_ALL_VISIBLE_OBJECTS list, you do
not need to supply a tag_array -- the list is automatically evaluated
when necessary.
For a UF_CLEAR_ALL_BUT list, you must specify the tags of those
solid bodies and/or facet models you want to explicitly exclude from
the list. The list of included objects is reevaluated when necessary.
For a UF_CLEAR_FIXED_LIST, you must specify an array of objects
to be members of the list. These objects must be solid bodies or facet
models. This list is not further evaluated. Note that you may need to
call this routine twice, once for each list.
返回
Return code:
0 = No error
not 0 = Error code, which includes
UF_CLEAR_err_bad_dataset
UF_CLEAR_err_bad_list_num
UF_CLEAR_err_bad_list_type
UF_CLEAR_err_bad_list_data.
环境
内部和外部
参见
需要许可证（S）
assemblies
int UF_CLEAR_set_obj_list
(
tag_t dataset,
int which_list,
int list_type,
int list_size,
tag_t * tag_array
)
| tag_t （tag_t类型） | dataset | Input（输入） | The dataset tag. |
| int (整数型) | which_list | Input（输入） | Is this for list 1 or list 2? Acceptable values are 1
and 2. |
| int (整数型) | list_type | Input（输入） | The new type of list
(UF_CLEAR_ALL_OBJECTS,
UF_CLEAR_ALL_VISIBLE_OBJECTS,
UF_CLEAR_ALL_BUT,
UF_CLEAR_FIXED_LIST, or
UF_CLEAR_LIST2_NOT_USED). |
| int (整数型) | list_size | Input（输入） | The size of tag_array. |
| tag_t * (tag_t型的指针) | tag_array | Input（输入） | list_size
The object tags (solids or facets) to be applied to
the list. |
UF_CLEAR_set_object_clear_zone (查看源代码)
定义在: uf_clear.h
概述
Assigns the clearance zone for the given object. The object must be a
member of the data set. During analysis, any object pair that doesn't
have a clearance zone explicitly assigned to that pair uses the greater
of the clearance zones assigned to each object. You must supply the
tag of a valid expression.
返回
Return code:
0 = No error
not 0 = Error code, which includes
UF_CLEAR_err_bad_dataset
UF_CLEAR_err_bad_expression.
环境
内部和外部
参见
需要许可证（S）
assemblies
int UF_CLEAR_set_object_clear_zone
(
tag_t dataset,
tag_t object,
tag_t clr_zone
)
UF_CLEAR_set_pair_clear_zone (查看源代码)
定义在: uf_clear.h
概述
Assign the clearance zone for the given object pair. Each object must
be a member of the data set. During analysis, the pair clearance zones
overrides any clearance zones assigned to the individual objects. You
must supply the tag of a valid expression.
返回
Return code:
0 = No error
not 0 = Error code, which includes
UF_CLEAR_err_bad_dataset
UF_CLEAR_err_bad_expression.
环境
内部和外部
参见
需要许可证（S）
assemblies
int UF_CLEAR_set_pair_clear_zone
(
tag_t dataset,
tag_t object1,
tag_t object2,
tag_t clr_zone
)
UF_CLEAR_set_pair_exclusion (查看源代码)
定义在: uf_clear.h
概述
Explicitly excludes an object pair from analysis. Each object must be a
member of the data set. You may associate a text string with the pair.
The string must be equal to or less than MAX_LINE_SIZE characters
long.
返回
Return code:
0 = No error
not 0 = Error code, which includes
UF_CLEAR_err_bad_dataset
UF_CLEAR_err_bad_string.
环境
内部和外部
参见
需要许可证（S）
assemblies
int UF_CLEAR_set_pair_exclusion
(
tag_t dataset,
tag_t object1,
tag_t object2,
char * text
)
| tag_t （tag_t类型） | dataset | Input（输入） | The data set tag. |
| tag_t （tag_t类型） | object1 | Input（输入） | The first object (solid or facet) in the pair. |
| tag_t （tag_t类型） | object2 | Input（输入） | The second object (solid or facet) in the pair. |
| char * (字符型指针) | text | Input（输入） | The text to associate with each pair. |
UF_CLEAR_set_pair_inclusion (查看源代码)
定义在: uf_clear.h
概述
Explicitly includes an object pair in analysis. Each object must be a
member of the data set. You may associate a text string with the pair.
The string must be equal to or less than MAX_LINE_SIZE characters
long.
返回
Return code:
0 = No error
not 0 = Error code, which includes
UF_CLEAR_err_bad_dataset
UF_CLEAR_err_bad_string.
环境
内部和外部
参见
需要许可证（S）
assemblies
int UF_CLEAR_set_pair_inclusion
(
tag_t dataset,
tag_t object1,
tag_t object2,
char * text
)
| tag_t （tag_t类型） | dataset | Input（输入） | The dataset tag. |
| tag_t （tag_t类型） | object1 | Input（输入） | The first object (solid or facet) in the pair. |
| tag_t （tag_t类型） | object2 | Input（输入） | The second object (solid or facet) in the pair. |
| char * (字符型指针) | text | Input（输入） | The text to associate with each pair. |
UF_CLEAR_set_preferences (查看源代码)
定义在: uf_clear.h
概述
Sets clearance module preferences. The structure contains the current
interactive message filter, which indicates the types of interferences
that are displayed by the interactive analysis and review functions.
Each bit of this integer refers to a specific type of interference
(UF_CLEAR_SOFT_INTERFERENCE, etc.). Use the appropriate C
bitwise logical operators (&, |, and ^) to set this value. The
save_interference parameter indicates if the interference bodies are
to be saved during analysis. The layer and color assignments will be
given to all new interference bodies. The attention colors for
interferences and the parent objects will be used in the interactive
review of analysis results. If you want to set just one of the values, you
must call UF_CLEAR_ask_preferences to fill the structure. Next, edit
those fields you want to change; then call UF_CLEAR_set_preferences.
The default values are:
interactive_msg_filter: ALL (i.e., display all).
save_interference: TRUE
interference_layer: 0 (current)
interference_color: YELLOW
interf_attn_color: RED
parent_attn_color: CYAN
These defaults are controlled by the customer defaults file. The default
behavior can be changed by editting that file.
返回
Return code:
0 = No error
not 0 = Error code, which includes
UF_CLEAR_err_bad_dataset
UF_CLEAR_err_bad_msg_filter
UF_CLEAR_err_bad_layer
UF_CLEAR_err_bad_color.
环境
内部和外部
需要许可证（S）
assemblies
int UF_CLEAR_set_preferences
(
tag_t dataset,
UF_CLEAR_pref_t preferences
)