ProximitySearchTermBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# ProximitySearchTermBuilder Class

class `NXOpen.Assemblies.``ProximitySearchTermBuilder`

  Bases: `NXOpen.Assemblies.SearchTermBuilder`

  A ProximitySearchTermBuilder is used to create or edit an `Assemblies.BoxSearchTerm`.

  To create a new instance of this class, use `NXOpen.Assemblies.SubsetCollection.CreateProximitySearchTermBuilder()`

  New in version NX8.5.0.

# Properties

Property | Description
--- | ---
Distance | Returns or sets the distance.
SearchTermLogic | Returns or sets the search term logic.
Tag | Returns the Tag for this object.
TrueShapeRefinement | Returns or sets the true-shape refinement.

# 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.
GetObject | Returns the object currently being edited by this builder.
GetSeeds | Get the proximity search term seed elements.
SetSeeds | Set the proximity search term seed elements.
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.

# Property Detail

## Distance

`ProximitySearchTermBuilder.``Distance`

  Returns or sets the distance.

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

  Getter Method

  Signature `Distance`

  Returns: |
  Return type: | float

  New in version NX8.5.0.

  License requirements: nx_4gd_integration (“4th Generation Design”)

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

  Setter Method

  Signature `Distance`

  Parameters: | distance (float) –

  New in version NX8.5.0.

  License requirements: nx_4gd_integration (“4th Generation Design”)

## SearchTermLogic

`ProximitySearchTermBuilder.``SearchTermLogic`

  Returns or sets the search term logic.

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

  Getter Method

  Signature `SearchTermLogic`

  Returns: |
  Return type: | `NXOpen.Assemblies.SearchTermSearchTermLogicType`

  New in version NX8.5.0.

  License requirements: nx_4gd_integration (“4th Generation Design”)

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

  Setter Method

  Signature `SearchTermLogic`

  Parameters: | searchTermLogic (`NXOpen.Assemblies.SearchTermSearchTermLogicType`) –

  New in version NX8.5.0.

  License requirements: nx_4gd_integration (“4th Generation Design”)

## TrueShapeRefinement

`ProximitySearchTermBuilder.``TrueShapeRefinement`

  Returns or sets the true-shape refinement.

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

  Getter Method

  Signature `TrueShapeRefinement`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: nx_4gd_integration (“4th Generation Design”)

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

  Setter Method

  Signature `TrueShapeRefinement`

  Parameters: | trueShapeRefinement (bool) –

  New in version NX8.5.0.

  License requirements: nx_4gd_integration (“4th Generation Design”)

# Method Detail

## GetSeeds

`ProximitySearchTermBuilder.``GetSeeds`

  Get the proximity search term seed elements.

  Signature `GetSeeds()`

  Returns: |
  Return type: | list of `NXOpen.Assemblies.SearchResultElement`

  New in version NX8.5.0.

  License requirements: nx_4gd_integration (“4th Generation Design”)

## SetSeeds

`ProximitySearchTermBuilder.``SetSeeds`

  Set the proximity search term seed elements.

  Signature `SetSeeds(seeds)`

  Parameters: | seeds (list of `NXOpen.Assemblies.SearchResultElement`) –

  New in version NX8.5.0.

  License requirements: nx_4gd_integration (“4th Generation Design”)

## Validate

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