ProbeToolBuilder Class¶
-
class
NXOpen.CAM.ProbeToolBuilder¶ Bases:
NXOpen.CAM.SolidToolBuilderRepresents a Probe Tool Builder
To create a new instance of this class, use
NXOpen.CAM.NCGroupCollection.CreateProbeToolBuilder()New in version NX5.0.0.
Properties¶
| Property | Description |
|---|---|
| ChannelName | Returns or sets the channel’s name |
| CutterExportBuilder | Returns the cutter export builder |
| CycleEvent | Returns the cycle event |
| CycleTable | Returns the cycle |
| Description | Returns or sets the description |
| EndUdeSet | Returns the end ude set |
| HolderDescription | Returns or sets the holder description |
| HolderLibraryReference | Returns or sets the holder libref |
| LibraryParametersBuilder | Returns the Library Data Object |
| OptimizationMethod | Returns or sets the optim method |
| StartUdeSet | Returns the start ude set |
| Tag | Returns the Tag for this object. |
| TlCtlgNum | Returns or sets the Catalog Number |
| TlDescription | Returns or sets the Cutter Description |
| TlHolderNumberBuilder | Returns the Holder Number |
| TlLibref | Returns or sets the Cutter Libref |
| TlManualToolChange | Returns or sets the Manual Tool Change |
| TlMountingJunction | Returns or sets the T1 mounting junction |
| TlNumberBuilder | Returns the Tool Number |
| TlText | Returns or sets the tool text |
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 |
| GetMaterial | Get tool material |
| GetMaterialData | Get material data |
| GetObject | Returns the object currently being edited by this builder. |
| SetMaterial | Set tool material |
| 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. |
Method Detail¶
Validate¶
-
ProbeToolBuilder.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.