ClearanceAnalysisBuilder Class

class NXOpen.Assemblies.ClearanceAnalysisBuilder

Bases: NXOpen.Builder

Represents NXOpen.Assemblies.ClearanceAnalysisBuilder.

The builder builds the clearance set which contains properties for the analysis. The properties are:

Clearance Set Name: the name of the clearance set.

Clearance Type: either components or bodies or PSM facet objects.

Number of collections: either one or two. Where one collection is chosen, the analysis is performed between all objects in the collection. Where two collections are chosen, the analysis compares objects from one collection with objects from the other.

Exceptions: Select Subassemblies: Specific subassemblies selected within the displayed part can be treated as a single entity.

Explicitly Ignore: A number of options to reduce the amount of results reported.

Additional exceptions: Addtional pairs of objects to be excluded or included regardless of exception rules previously defined.

To create a new instance of this class, use NXOpen.Assemblies.AssemblyManager.CreateClearanceAnalysisBuilder()

New in version NX9.0.0.

Properties

Property Description
CalculationMethod Returns or sets the setting for the clearance calculation method.
ClearanceBetween Returns or sets the setting to determine whether components or bodies should be used.
ClearanceSetName Returns or sets the clearance set name.
CollectionOneObjects Returns the selected objects for collection one.
CollectionOneRange Returns or sets the range setting for collection one.
CollectionTwoObjects Returns the selected objects for collection two.
CollectionTwoRange Returns or sets the range setting for collection two.
InterferenceColor Returns or sets the color of the interference geometry.
IsCalculatePenetrationDepth Returns or sets the setting to determine whether penetration depth should be calculated.
IsIgnorePairsWithinSameGroup Returns or sets the setting to determine whether to ignore pairs within same group.
IsIgnorePairsWithinSamePart Returns or sets the setting to determine whether to ignore pairs within same part.
IsIgnorePairsWithinSameSubassembly Returns or sets the setting to determine whether to ignore pairs within same subassembly.
IsIgnorePairsWithinSelectedSubassemblies Returns or sets the setting to determine whether to ignore pairs within the selected subassemblies.
Layer Returns or sets the layer for interference geometry.
SaveInterferenceGeometry Returns or sets the setting to determine if interference geometry should be saved.
Tag Returns the Tag for this object.
TotalCollectionCount Returns or sets the setting to determine whether one collection or two collections should be used.
UnitSubassemblies Returns the selected unit subassemblies.

Methods

Method Description
AddException Add an exception.
AddObjectClearanceZone Add a Clearance Zone around an object.
AddPairClearanceZone Add a Clearance Zone between a pair of objects.
Commit Commits any edits that have been applied to the builder.
CreateClearanceZoneExpression Create an expression using the Clearance Zone naming convention.
DeleteException Delete an exception.
DeleteObjectClearanceZone Delete an existing Clearance Zone from around an object.
DeletePairClearanceZone Delete an existing Clearance Zone between the given pair of objects.
Destroy Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects For builders that create more than one object, this method returns the objects that are created by commit.
GetDefaultClearanceZone Get the default Clearance Zone expression.
GetIsPairIncluded Inquires if an object pair is to be included in the analysis.
GetObject Returns the object currently being edited by this builder.
GetObjectClearanceZone Inquire the Clearance Zone assigned to a given object.
GetPairClearanceZone Inquire the Clearance Zone for a specific pair of objects.
SetDefaultClearanceZone Set the expression as the default Clearance Zone.
ShowResults Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

ClearanceAnalysisBuilderCalculationMethodType Enumeration Specify the analysis method.
ClearanceAnalysisBuilderClearanceBetweenEntity Enumeration Specify the type of clearance analysis.
ClearanceAnalysisBuilderClearanceZoneSource Enumeration Specify the source of the clearance zone
ClearanceAnalysisBuilderCollectionRange Enumeration Specify how to compare objects inside a collection.
ClearanceAnalysisBuilderNumberOfCollections Enumeration Specify the number of collections used for clearance analysis.
ClearanceAnalysisBuilderPairExcludedReason Enumeration Specify the reason for excluding the pair
ClearanceAnalysisBuilderZoneType Enumeration Specify the clearance zone type.

Property Detail

CalculationMethod

ClearanceAnalysisBuilder.CalculationMethod

Returns or sets the setting for the clearance calculation method.

-------------------------------------

Getter Method

Signature CalculationMethod

Returns:
Return type:NXOpen.Assemblies.ClearanceAnalysisBuilderCalculationMethodType

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature CalculationMethod

Parameters:calculateMethod (NXOpen.Assemblies.ClearanceAnalysisBuilderCalculationMethodType) –

New in version NX9.0.0.

License requirements: assemblies (“ASSEMBLIES MODULE”)

ClearanceBetween

ClearanceAnalysisBuilder.ClearanceBetween

Returns or sets the setting to determine whether components or bodies should be used.

Please note that changing the collection type will clear the collections, exceptions and clearance zones from the clearance set

-------------------------------------

Getter Method

Signature ClearanceBetween

Returns:
Return type:NXOpen.Assemblies.ClearanceAnalysisBuilderClearanceBetweenEntity

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ClearanceBetween

Parameters:clearanceBetweenEntity (NXOpen.Assemblies.ClearanceAnalysisBuilderClearanceBetweenEntity) –

New in version NX9.0.0.

License requirements: assemblies (“ASSEMBLIES MODULE”)

ClearanceSetName

ClearanceAnalysisBuilder.ClearanceSetName

Returns or sets the clearance set name.

-------------------------------------

Getter Method

Signature ClearanceSetName

Returns:
Return type:str

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ClearanceSetName

Parameters:clearanceSetName (str) –

New in version NX9.0.0.

License requirements: assemblies (“ASSEMBLIES MODULE”)

CollectionOneObjects

ClearanceAnalysisBuilder.CollectionOneObjects

Returns the selected objects for collection one.

-------------------------------------

Getter Method

Signature CollectionOneObjects

Returns:
Return type:NXOpen.SelectDisplayableObjectList

New in version NX9.0.0.

License requirements: assemblies (“ASSEMBLIES MODULE”)

CollectionOneRange

ClearanceAnalysisBuilder.CollectionOneRange

Returns or sets the range setting for collection one.

-------------------------------------

Getter Method

Signature CollectionOneRange

Returns:
Return type:NXOpen.Assemblies.ClearanceAnalysisBuilderCollectionRange

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature CollectionOneRange

Parameters:collectionRange (NXOpen.Assemblies.ClearanceAnalysisBuilderCollectionRange) –

New in version NX9.0.0.

License requirements: assemblies (“ASSEMBLIES MODULE”)

CollectionTwoObjects

ClearanceAnalysisBuilder.CollectionTwoObjects

Returns the selected objects for collection two.

-------------------------------------

Getter Method

Signature CollectionTwoObjects

Returns:
Return type:NXOpen.SelectDisplayableObjectList

New in version NX9.0.0.

License requirements: None.

CollectionTwoRange

ClearanceAnalysisBuilder.CollectionTwoRange

Returns or sets the range setting for collection two.

-------------------------------------

Getter Method

Signature CollectionTwoRange

Returns:
Return type:NXOpen.Assemblies.ClearanceAnalysisBuilderCollectionRange

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature CollectionTwoRange

Parameters:collectionRange (NXOpen.Assemblies.ClearanceAnalysisBuilderCollectionRange) –

New in version NX9.0.0.

License requirements: assemblies (“ASSEMBLIES MODULE”)

InterferenceColor

ClearanceAnalysisBuilder.InterferenceColor

Returns or sets the color of the interference geometry.

-------------------------------------

Getter Method

Signature InterferenceColor

Returns:
Return type:Id

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature InterferenceColor

Parameters:color (Id) –

New in version NX9.0.0.

License requirements: assemblies (“ASSEMBLIES MODULE”)

IsCalculatePenetrationDepth

ClearanceAnalysisBuilder.IsCalculatePenetrationDepth

Returns or sets the setting to determine whether penetration depth should be calculated.

-------------------------------------

Getter Method

Signature IsCalculatePenetrationDepth

Returns:
Return type:bool

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature IsCalculatePenetrationDepth

Parameters:isCalculatePenetrationDepth (bool) –

New in version NX9.0.0.

License requirements: assemblies (“ASSEMBLIES MODULE”)

IsIgnorePairsWithinSameGroup

ClearanceAnalysisBuilder.IsIgnorePairsWithinSameGroup

Returns or sets the setting to determine whether to ignore pairs within same group.

-------------------------------------

Getter Method

Signature IsIgnorePairsWithinSameGroup

Returns:
Return type:bool

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature IsIgnorePairsWithinSameGroup

Parameters:isIgnorePairsWithinSameGroup (bool) –

New in version NX9.0.0.

License requirements: assemblies (“ASSEMBLIES MODULE”)

IsIgnorePairsWithinSamePart

ClearanceAnalysisBuilder.IsIgnorePairsWithinSamePart

Returns or sets the setting to determine whether to ignore pairs within same part.

-------------------------------------

Getter Method

Signature IsIgnorePairsWithinSamePart

Returns:
Return type:bool

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature IsIgnorePairsWithinSamePart

Parameters:isIgnorePairsWithinSamePart (bool) –

New in version NX9.0.0.

License requirements: assemblies (“ASSEMBLIES MODULE”)

IsIgnorePairsWithinSameSubassembly

ClearanceAnalysisBuilder.IsIgnorePairsWithinSameSubassembly

Returns or sets the setting to determine whether to ignore pairs within same subassembly.

-------------------------------------

Getter Method

Signature IsIgnorePairsWithinSameSubassembly

Returns:
Return type:bool

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature IsIgnorePairsWithinSameSubassembly

Parameters:isIgnorePairsWithinSameSubassembly (bool) –

New in version NX9.0.0.

License requirements: assemblies (“ASSEMBLIES MODULE”)

IsIgnorePairsWithinSelectedSubassemblies

ClearanceAnalysisBuilder.IsIgnorePairsWithinSelectedSubassemblies

Returns or sets the setting to determine whether to ignore pairs within the selected subassemblies.

-------------------------------------

Getter Method

Signature IsIgnorePairsWithinSelectedSubassemblies

Returns:
Return type:bool

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature IsIgnorePairsWithinSelectedSubassemblies

Parameters:isIgnorePairsWithinSelectedSubassemblies (bool) –

New in version NX9.0.0.

License requirements: assemblies (“ASSEMBLIES MODULE”)

Layer

ClearanceAnalysisBuilder.Layer

Returns or sets the layer for interference geometry.

-------------------------------------

Getter Method

Signature Layer

Returns:
Return type:int

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Layer

Parameters:layer (int) –

New in version NX9.0.0.

License requirements: assemblies (“ASSEMBLIES MODULE”)

SaveInterferenceGeometry

ClearanceAnalysisBuilder.SaveInterferenceGeometry

Returns or sets the setting to determine if interference geometry should be saved.

-------------------------------------

Getter Method

Signature SaveInterferenceGeometry

Returns:
Return type:bool

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature SaveInterferenceGeometry

Parameters:saveInterferenceGeometry (bool) –

New in version NX9.0.0.

License requirements: assemblies (“ASSEMBLIES MODULE”)

TotalCollectionCount

ClearanceAnalysisBuilder.TotalCollectionCount

Returns or sets the setting to determine whether one collection or two collections should be used.

-------------------------------------

Getter Method

Signature TotalCollectionCount

Returns:
Return type:NXOpen.Assemblies.ClearanceAnalysisBuilderNumberOfCollections

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature TotalCollectionCount

Parameters:totalCollectionCount (NXOpen.Assemblies.ClearanceAnalysisBuilderNumberOfCollections) –

New in version NX9.0.0.

License requirements: assemblies (“ASSEMBLIES MODULE”)

UnitSubassemblies

ClearanceAnalysisBuilder.UnitSubassemblies

Returns the selected unit subassemblies.

-------------------------------------

Getter Method

Signature UnitSubassemblies

Returns:
Return type:NXOpen.SelectDisplayableObjectList

New in version NX9.0.0.

License requirements: None.

Method Detail

AddException

ClearanceAnalysisBuilder.AddException

Add an exception.

Signature AddException(isExclude, comp1, comp2, text)

Parameters:

New in version NX9.0.0.

License requirements: assemblies (“ASSEMBLIES MODULE”)

AddObjectClearanceZone

ClearanceAnalysisBuilder.AddObjectClearanceZone

Add a Clearance Zone around an object.

Create the expression using CreateClearanceZoneExpression() if the Clearance Zone expression naming convention is desired.

Signature AddObjectClearanceZone(object, expression)

Parameters:

New in version NX9.0.0.

License requirements: assemblies (“ASSEMBLIES MODULE”)

AddPairClearanceZone

ClearanceAnalysisBuilder.AddPairClearanceZone

Add a Clearance Zone between a pair of objects.

Create the expression using CreateClearanceZoneExpression() if the Clearance Zone expression naming convention is desired.

Signature AddPairClearanceZone(object1, object2, expression)

Parameters:

New in version NX9.0.0.

License requirements: assemblies (“ASSEMBLIES MODULE”)

CreateClearanceZoneExpression

ClearanceAnalysisBuilder.CreateClearanceZoneExpression

Create an expression using the Clearance Zone naming convention.

The expression is intended for use in the following methods: NXOpen.Assemblies.ClearanceAnalysisBuilder.SetDefaultClearanceZone() NXOpen.Assemblies.ClearanceAnalysisBuilder.AddPairClearanceZone() NXOpen.Assemblies.ClearanceAnalysisBuilder.AddObjectClearanceZone()

Signature CreateClearanceZoneExpression(rhsExpression)

Parameters:rhsExpression (str) – the text for the expression
Returns:the new expression
Return type:NXOpen.Expression

New in version NX9.0.0.

License requirements: assemblies (“ASSEMBLIES MODULE”)

DeleteException

ClearanceAnalysisBuilder.DeleteException

Delete an exception.

Signature DeleteException(comp1, comp2)

Parameters:

New in version NX9.0.0.

License requirements: assemblies (“ASSEMBLIES MODULE”)

DeleteObjectClearanceZone

ClearanceAnalysisBuilder.DeleteObjectClearanceZone

Delete an existing Clearance Zone from around an object.

Signature DeleteObjectClearanceZone(object)

Parameters:object (NXOpen.DisplayableObject) – the object

New in version NX9.0.0.

License requirements: assemblies (“ASSEMBLIES MODULE”)

DeletePairClearanceZone

ClearanceAnalysisBuilder.DeletePairClearanceZone

Delete an existing Clearance Zone between the given pair of objects.

Signature DeletePairClearanceZone(object1, object2)

Parameters:

New in version NX9.0.0.

License requirements: assemblies (“ASSEMBLIES MODULE”)

GetDefaultClearanceZone

ClearanceAnalysisBuilder.GetDefaultClearanceZone

Get the default Clearance Zone expression.

If there is no expression set previously, a None will be returned.

Signature GetDefaultClearanceZone()

Returns:the expression
Return type:NXOpen.Expression

New in version NX9.0.0.

License requirements: assemblies (“ASSEMBLIES MODULE”)

GetIsPairIncluded

ClearanceAnalysisBuilder.GetIsPairIncluded

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 includeIt is returned as TRUE. The reason parameter signifies why the pair is included or excluded. The text parameter is only returned for the NXOpen.Assemblies.ClearanceAnalysisBuilderPairExcludedReason.UserDefined reason.

Signature GetIsPairIncluded(object1, object2)

Parameters:
Returns:

a tuple
Return type:

A tuple consisting of (includeIt, reason, text). includeIt is a bool. the flag reason is a NXOpen.Assemblies.ClearanceAnalysisBuilderPairExcludedReason. the reason text is a str. the text

New in version NX9.0.0.

License requirements: assemblies (“ASSEMBLIES MODULE”)

GetObjectClearanceZone

ClearanceAnalysisBuilder.GetObjectClearanceZone

Inquire the Clearance Zone assigned to a given object.

The object must be a member of the dataset. The expression, the distance, and the source are the outputs. If no expression has ever been set, the part of the given object is checked for a Clearance Zone expression, if none is found, None will be returned for the expression. Interpret its value as 0.0 (this is the default value). The source parameter tells where the clearance zone comes from. NXOpen.Assemblies.ClearanceAnalysisBuilderClearanceZoneSource.Defined specifies that the object has its own Clearance Zone. NXOpen.Assemblies.ClearanceAnalysisBuilderClearanceZoneSource.Default means the default clearance zone is used.

Signature GetObjectClearanceZone(object)

Parameters:object (NXOpen.DisplayableObject) – the object
Returns:a tuple
Return type:A tuple consisting of (source, expression). source is a NXOpen.Assemblies.ClearanceAnalysisBuilderClearanceZoneSource. the source of the clearance zone expression is a NXOpen.Expression. the expression

New in version NX9.0.0.

License requirements: assemblies (“ASSEMBLIES MODULE”)

GetPairClearanceZone

ClearanceAnalysisBuilder.GetPairClearanceZone

Inquire the Clearance Zone for a specific pair of objects.

Both objects must be members of the Clearance Set. 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 (NXOpen.Assemblies.ClearanceAnalysisBuilderClearanceZoneSource.Object1 or NXOpen.Assemblies.ClearanceAnalysisBuilderClearanceZoneSource.Object2. NXOpen.Assemblies.ClearanceAnalysisBuilderClearanceZoneSource.Pair means this pair has its own explicit clearance zone. NXOpen.Assemblies.ClearanceAnalysisBuilderClearanceZoneSource.Default means the default clearance zone is used..

Signature GetPairClearanceZone(object1, object2)

Parameters:
Returns:

a tuple
Return type:

A tuple consisting of (source, expression). source is a NXOpen.Assemblies.ClearanceAnalysisBuilderClearanceZoneSource. the source of the clearance zone expression is a NXOpen.Expression. the corresponding expression

New in version NX9.0.0.

License requirements: assemblies (“ASSEMBLIES MODULE”)

SetDefaultClearanceZone

ClearanceAnalysisBuilder.SetDefaultClearanceZone

Set the expression as the default Clearance Zone.

Create the expression using CreateClearanceZoneExpression() if the Clearance Zone expression naming convention is desired.

Signature SetDefaultClearanceZone(expression)

Parameters:expression (NXOpen.Expression) – the expression

New in version NX9.0.0.

License requirements: assemblies (“ASSEMBLIES MODULE”)

Validate

ClearanceAnalysisBuilder.Validate

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

Signature Validate()

Returns:Was self validation successful
Return type:bool

New in version NX3.0.1.

License requirements: None.