SimpleInterference Class — NXOpen Python API Reference 12.0.0 documentation

# SimpleInterference Class

class `NXOpen.GeometricAnalysis.``SimpleInterference`

  Bases: `NXOpen.Builder`

  Represents the Simple Interference object.

  A `NXOpen.GeometricAnalysis.SimpleInterference` object takes two solid bodies as inputs and the type of interference results to be produced. It can report the first pair of interfering faces between two solids or all pairs of interfering faces. It can also create the interference solid(s) between two bodies.

  To create a new instance of this class, use `NXOpen.GeometricAnalysis.AnalysisManager.CreateSimpleInterferenceObject()`

  New in version NX5.0.0.

# Properties

Property | Description
--- | ---
FaceInterferenceType | Returns or sets the FaceInterferenceType.
FirstBody | Returns the First Body
InterferenceType | Returns or sets the InterferenceType.
SecondBody | Returns the Second Body
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
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.
GetInterferenceResults | Returns the pair(s) of interfering faces or solid(s) of interference between the input bodies.
GetObject | Returns the object currently being edited by this builder.
HighlightNextPair | Highlights the pairs of interfering faces after a `NXOpen.GeometricAnalysis.SimpleInterference.PerformCheck()`.
PerformCheck | Perform Interference Check.
Reset | Frees up resources/results associated with `NXOpen.GeometricAnalysis.SimpleInterference` object after a call to `NXOpen.GeometricAnalysis.SimpleInterference.PerformCheck()`.
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

SimpleInterferenceFaceInterferenceMethod Enumeration | Specifies to find only first pair of interfering faces or all pairs of interfering faces between the input boides.
SimpleInterferenceInterferenceMethod Enumeration | Specifies interference method, i.
SimpleInterferenceResult Enumeration | Specifies the result of a simple interference check

# Property Detail

## FaceInterferenceType

`SimpleInterference.``FaceInterferenceType`

  Returns or sets the FaceInterferenceType.

  `NXOpen.GeometricAnalysis.SimpleInterference.FaceInterferenceType`()` is used when `NXOpen.GeometricAnalysis.SimpleInterference.InterferenceType`()` is set to `NXOpen.GeometricAnalysis.SimpleInterferenceInterferenceMethod.InterferingFaces`, i.e., create pair(s) of interfering faces between two solids. A value of `NXOpen.GeometricAnalysis.SimpleInterferenceFaceInterferenceMethod.FirstPairOnly` for `NXOpen.GeometricAnalysis.SimpleInterference.FaceInterferenceType`()` reports only the first pair of interfering faces and value of `NXOpen.GeometricAnalysis.SimpleInterferenceFaceInterferenceMethod.AllPairs` reports all pairs of interfering faces between two bodies.

  `-------------------------------------`

  Getter Method

  Signature `FaceInterferenceType`

  Returns: |
  Return type: | `NXOpen.GeometricAnalysis.SimpleInterferenceFaceInterferenceMethod`

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `FaceInterferenceType`

  Parameters: | faceInterferenceType (`NXOpen.GeometricAnalysis.SimpleInterferenceFaceInterferenceMethod`) –

  New in version NX5.0.0.

  License requirements: None.

## FirstBody

`SimpleInterference.``FirstBody`

  Returns the First Body

  `-------------------------------------`

  Getter Method

  Signature `FirstBody`

  Returns: |
  Return type: | `NXOpen.SelectObject`

  New in version NX5.0.0.

  License requirements: None.

## InterferenceType

`SimpleInterference.``InterferenceType`

  Returns or sets the InterferenceType.

  A value of `NXOpen.GeometricAnalysis.SimpleInterferenceInterferenceMethod.InterferingFaces` for `NXOpen.GeometricAnalysis.SimpleInterference.InterferenceType`()` reports the pairs of interfering faces between two solids. You can also further specify to report only the first pair of interfering faces or all pairs of interfering faces by `NXOpen.GeometricAnalysis.SimpleInterference.FaceInterferenceType`()`. A value of `NXOpen.GeometricAnalysis.SimpleInterferenceInterferenceMethod.InterferenceSolid` for `NXOpen.GeometricAnalysis.SimpleInterference.InterferenceType`()` creates the interference solid(s) between the two input bodies.

  `-------------------------------------`

  Getter Method

  Signature `InterferenceType`

  Returns: |
  Return type: | `NXOpen.GeometricAnalysis.SimpleInterferenceInterferenceMethod`

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `InterferenceType`

  Parameters: | interferenceType (`NXOpen.GeometricAnalysis.SimpleInterferenceInterferenceMethod`) –

  New in version NX5.0.0.

  License requirements: None.

## SecondBody

`SimpleInterference.``SecondBody`

  Returns the Second Body

  `-------------------------------------`

  Getter Method

  Signature `SecondBody`

  Returns: |
  Return type: | `NXOpen.SelectObject`

  New in version NX5.0.0.

  License requirements: None.

# Method Detail

## GetInterferenceResults

`SimpleInterference.``GetInterferenceResults`

  Returns the pair(s) of interfering faces or solid(s) of interference between the input bodies.

  nObjects will be 0 if there is no face or solid interference between the input bodies. If the `NXOpen.GeometricAnalysis.SimpleInterference.InterferenceType`()` is `NXOpen.GeometricAnalysis.SimpleInterferenceInterferenceMethod.InterferingFaces`, pair(s) of interfering faces are returned. The first two objects represent the first pair of interfering faces, and next two objects represent the second pair of interering faces and so on. If the `NXOpen.GeometricAnalysis.SimpleInterference.FaceInterferenceType`()` is `NXOpen.GeometricAnalysis.SimpleInterferenceFaceInterferenceMethod.FirstPairOnly`, only the first pair of interfering faces are returned.

  Signature `GetInterferenceResults()`

  Returns: | Results of Simple Interference
  Return type: | list of `NXOpen.NXObject`

  New in version NX6.0.2.

  License requirements: None.

## HighlightNextPair

`SimpleInterference.``HighlightNextPair`

  Highlights the pairs of interfering faces after a `NXOpen.GeometricAnalysis.SimpleInterference.PerformCheck()`.

  This method is applicable only when `NXOpen.GeometricAnalysis.SimpleInterference.InterferenceType`()` is set to `NXOpen.GeometricAnalysis.SimpleInterferenceInterferenceMethod.InterferingFaces` and `NXOpen.GeometricAnalysis.SimpleInterference.FaceInterferenceType`()` is set to `NXOpen.GeometricAnalysis.SimpleInterferenceFaceInterferenceMethod.AllPairs`. When highlighting the next pair, current pair of faces is unhighlighted. Return value is set to true if there are more pairs of faces to be highlighted. If the last pair is reached (i.e., the pair being highlighted in this call is the last pair of faces), return value is set to false.

  Signature `HighlightNextPair()`

  Returns: | Indicates if there are

  any more pairs left . :rtype: bool

  New in version NX5.0.0.

  License requirements: None.

## PerformCheck

`SimpleInterference.``PerformCheck`

  Perform Interference Check.

  `NXOpen.GeometricAnalysis.SimpleInterference.PerformCheck()` should be called after specifiying input bodies to be checked, i.e., `NXOpen.GeometricAnalysis.SimpleInterference.FirstBody()` and `NXOpen.GeometricAnalysis.SimpleInterference.SecondBody()`. The return value `NXOpen.GeometricAnalysis.SimpleInterferenceResult` specifies the type of interference existing between the input bodies. Use `NXOpen.GeometricAnalysis.SimpleInterference.GetInterferenceResults()` to obtain the interfering faces or solid(s) of interference between the input bodis.

  Signature `PerformCheck()`

  Returns: | Indicates

  the type of interference existing between the input bodies. :rtype: `NXOpen.GeometricAnalysis.SimpleInterferenceResult`

  New in version NX5.0.0.

  License requirements: None.

## Reset

`SimpleInterference.``Reset`

  Frees up resources/results associated with `NXOpen.GeometricAnalysis.SimpleInterference` object after a call to `NXOpen.GeometricAnalysis.SimpleInterference.PerformCheck()`.

  `NXOpen.GeometricAnalysis.SimpleInterference.PerformCheck()` is followed by `NXOpen.GeometricAnalysis.SimpleInterference.GetInterferenceResults()` and the `NXOpen.GeometricAnalysis.SimpleInterference.Reset()`.

  Signature `Reset()`

  New in version NX5.0.0.

  License requirements: None.

## Validate

`SimpleInterference.``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.