NXOpen.UF.Clear.IsPairIncluded

Clear.IsPairIncluded()

Refer to UF_CLEAR_is_pair_included for documentation.

Deprecated since version NX9.0: Please use Assemblies::ClearanceAnalysisBuilder::GetIsPairIncluded() instead.

Signature: IsPairIncluded(dataset, object1, object2)

Parameters:
  • dataset (Tag) – The dataset tag.
  • object1 (Tag) – The first object (solid or facet) in the pair.
  • object2 (Tag) – The second object (solid or facet) in the pair.
Returns:

A Tuple
Return type:

A tuple consisting of (includeIt,reason,text)

includeIt(bool): Should this pair be included in the analysis?

reason(int): 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).

text(str): 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.

License requirements: None