RunContentProximitySearchTermBuilder Class¶
-
class
NXOpen.Assemblies.RunContentProximitySearchTermBuilder¶ Bases:
NXOpen.Assemblies.SearchTermBuilderA RunContentProximitySearchTermBuilder is used to create or edit an
Assemblies.RunContentProximitySearchTerm.To create a new instance of this class, use
NXOpen.Assemblies.SubsetCollection.CreateRunContentProximitySearchTermBuilder()New in version NX11.0.0.
Properties¶
| Property | Description |
|---|---|
| Distance | Returns or sets the distance for the proximity. |
| 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. |
| GetSeedName | Get the seed element name which is used in RunContentProximity search. |
| SetSeedName | Set the seed element name which is used in RunContentProximity search. |
| 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¶
-
RunContentProximitySearchTermBuilder.Distance¶ Returns or sets the distance for the proximity.
-------------------------------------Getter Method
Signature
DistanceReturns: Return type: float New in version NX11.0.0.
License requirements: nx_4gd_integration (“4th Generation Design”)
-------------------------------------Setter Method
Signature
DistanceParameters: distance (float) – New in version NX11.0.0.
License requirements: nx_4gd_integration (“4th Generation Design”)
SearchTermLogic¶
-
RunContentProximitySearchTermBuilder.SearchTermLogic¶ Returns or sets the search term logic.
-------------------------------------Getter Method
Signature
SearchTermLogicReturns: Return type: NXOpen.Assemblies.SearchTermSearchTermLogicTypeNew in version NX11.0.0.
License requirements: nx_4gd_integration (“4th Generation Design”)
-------------------------------------Setter Method
Signature
SearchTermLogicParameters: searchTermLogic ( NXOpen.Assemblies.SearchTermSearchTermLogicType) –New in version NX11.0.0.
License requirements: nx_4gd_integration (“4th Generation Design”)
TrueShapeRefinement¶
-
RunContentProximitySearchTermBuilder.TrueShapeRefinement¶ Returns or sets the true-shape refinement.
-------------------------------------Getter Method
Signature
TrueShapeRefinementReturns: Return type: bool New in version NX11.0.0.
License requirements: nx_4gd_integration (“4th Generation Design”)
-------------------------------------Setter Method
Signature
TrueShapeRefinementParameters: trueShapeRefinement (bool) – New in version NX11.0.0.
License requirements: nx_4gd_integration (“4th Generation Design”)
Method Detail¶
GetSeedName¶
-
RunContentProximitySearchTermBuilder.GetSeedName¶ Get the seed element name which is used in RunContentProximity search.
The seed in this case is the name of the Run object. The 3D contents of this Run object will be used as seeds for the proximity search.
Signature
GetSeedName()Returns: Return type: str New in version NX11.0.0.
License requirements: nx_4gd_integration (“4th Generation Design”)
SetSeedName¶
-
RunContentProximitySearchTermBuilder.SetSeedName¶ Set the seed element name which is used in RunContentProximity search.
The seed in this case is the name of the Run object. The 3D contents of this Run object will be used as seeds for the proximity search.
Signature
SetSeedName(seedRunName)Parameters: seedRunName (str) – New in version NX11.0.0.
License requirements: nx_4gd_integration (“4th Generation Design”)
Validate¶
-
RunContentProximitySearchTermBuilder.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.