MergeBuilder Class¶
-
class
NXOpen.MechanicalRouting.MergeBuilder¶ Bases:
NXOpen.Builderthe Builder to Merge Component
To create a new instance of this class, use
NXOpen.MechanicalRouting.BuilderFactory.CreateMergeBuilder()New in version NX11.0.1.
Properties¶
| Property | Description |
|---|---|
| CandidateStockComponentCollector | Returns the routing component collector that collects candidate stock component to merge with target component |
| SimplifyPath | Returns or sets the simplify path setting |
| Tag | Returns the Tag for this object. |
| TargetStockComponentCollector | Returns the routing component collector that collects target stock component |
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. |
| 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¶
CandidateStockComponentCollector¶
-
MergeBuilder.CandidateStockComponentCollector¶ Returns the routing component collector that collects candidate stock component to merge with target component
-------------------------------------Getter Method
Signature
CandidateStockComponentCollectorReturns: Return type: NXOpen.Routing.RouteObjectCollectorNew in version NX11.0.1.
License requirements: routing_base (“Routing Basic”)
SimplifyPath¶
-
MergeBuilder.SimplifyPath¶ Returns or sets the simplify path setting
-------------------------------------Getter Method
Signature
SimplifyPathReturns: Return type: bool New in version NX11.0.1.
License requirements: routing_base (“Routing Basic”)
-------------------------------------Setter Method
Signature
SimplifyPathParameters: simplifyPath (bool) – New in version NX11.0.1.
License requirements: routing_base (“Routing Basic”)
TargetStockComponentCollector¶
-
MergeBuilder.TargetStockComponentCollector¶ Returns the routing component collector that collects target stock component
-------------------------------------Getter Method
Signature
TargetStockComponentCollectorReturns: Return type: NXOpen.Routing.RouteObjectCollectorNew in version NX11.0.1.
License requirements: routing_base (“Routing Basic”)
Method Detail¶
Validate¶
-
MergeBuilder.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.