MultiToolBuilder Class¶
-
class
NXOpen.CAM.MultiToolBuilder¶ Bases:
NXOpen.CAM.NCGroupBuilderRepresents a MultiTool Builder
To create a new instance of this class, use
NXOpen.CAM.NCGroupCollection.CreateMultiToolBuilder()New in version NX11.0.1.
Properties¶
| Property | Description |
|---|---|
| CycleEvent | Returns the cycle event |
| CycleTable | Returns the cycle |
| Description | Returns or sets the description |
| EndUdeSet | Returns the end ude set |
| MultiToolDescription | Returns or sets the multi tool description |
| OptimizationMethod | Returns or sets the optim method |
| StartUdeSet | Returns the start ude set |
| 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. |
| GetCustomizableItemBuilder | Returns the customizable item builder for the given customizable item name |
| GetCustomizableItemNames | Returns the names for all customizable item ids |
| 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. |
| UpdateFromLibrary | Update a library multi-tool from the library |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
MultiToolDescription¶
-
MultiToolBuilder.MultiToolDescription¶ Returns or sets the multi tool description
-------------------------------------Getter Method
Signature
MultiToolDescriptionReturns: the multi tool description Return type: str New in version NX11.0.1.
License requirements: None.
-------------------------------------Setter Method
Signature
MultiToolDescriptionParameters: name (str) – the multi tool description New in version NX11.0.1.
License requirements: cam_base (“CAM BASE”)
Method Detail¶
UpdateFromLibrary¶
-
MultiToolBuilder.UpdateFromLibrary¶ Update a library multi-tool from the library
Signature
UpdateFromLibrary()New in version NX11.0.2.
License requirements: cam_base (“CAM BASE”)
Validate¶
-
MultiToolBuilder.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.