HoleDrillingBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# HoleDrillingBuilder Class

class `NXOpen.CAM.``HoleDrillingBuilder`

  Bases: `NXOpen.CAM.HoleMachiningBuilder`

  Represents a HoleDrillingBuilder Builder

  To create a new instance of this class, use `NXOpen.CAM.OperationCollection.CreateHoleDrillingBuilder()`

  New in version NX9.0.0.

# Properties

Property | Description
--- | ---
ChannelName | Returns or sets the channel’s name
CollisionCheck | Returns or sets the collision check for cutting
ControlPointOffset | Returns or sets the control point offset type
CrossOverDistance | Returns the crossover distance
CutParameters | Returns the Hole Drilling Cut Parameters
CuttingParameters | Returns the Cut Parameters
CycleEvent | Returns the cycle event
CycleTable | Returns the cycle
Description | Returns or sets the description
EndOfPath | Returns the end event builder
EndUdeSet | Returns the end ude set
FeedsBuilder | Returns the feeds and speeds builder
Geometry | Returns the geometry builder
GougeChecking | Returns or sets the gouge checking flag
HoleAxisType | Returns or sets the Hole Axis Type
HoleDepth | Returns the max depth distance builder
HoleDepthType | Returns or sets the Hole Depth Type
IgnoreToolTip | Returns or sets the ignore tool tip flag
IntersectionStrategy | Returns or sets the control point offset type
LayoutAndLayer | Returns the Layer and Layout
MotionOutputBuilder | Returns the motion output builder
NonCuttingBuilder | Returns the non-cutting moves builder
Notes | Returns the notes builder
OppositeDirection | Returns the opposite direction
OptimizationBasedOn | Returns or sets the optimization based on in operation
OptimizationDistanceMethod | Returns or sets the optimization distance method in operation
OptimizationLevel | Returns or sets the optimization level in operation
OptimizationMethod | Returns or sets the optim method
PathDisplayOptions | Returns the path display options builder
PostToolPathExit | Returns or sets the environment variable that points to the post tool path generation library which has the exit
PredefinedDepth | Returns the predefined depth
RetractDistance | Returns the Retract Distance builder (inheritable double)
RetractDistanceOnToolAxisChange | Returns the Retract Distance on Tool Axis Change builder (inheritable double)
RetractOutputMode | Returns or sets the canned rettract output
SafeClearance | Returns the safe clearance builder
SelectToolFlag | Returns or sets the user selected tool
StartOfPath | Returns the start event builder
StartUdeSet | Returns the start ude set
Tag | Returns the Tag for this object.
ToolChangeSetting | Returns the tool change builder
ToolPathEditor | Returns the Tool Path Editor Builder
ToolPathSplitParametersBuilder | Returns the tool path split Parameters

# 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
GetFeatureGeometry | Returns the feature geometry
GetHoleAxisValues | Get the Hole Axis values
GetObject | Returns the object currently being edited by this builder.
GetToolDrivePoint | Get the name of the tool drive point
RemoveOverrides | Removes overridden attributes of features in the feature geometry
SetHoleAxisValues | Set the Hole Axis values
SetToolDrivePoint | Set the name of the tool drive point
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
UnlockFeatures | Unlocks locked features in the feature geometry
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

HoleDrillingBuilderControlPointOffsetType Enumeration | Available types for control point offset
HoleDrillingBuilderIntersectionStrategyType Enumeration | Available types for intersection strategy
HoleDrillingBuilderRetractOutputModeType Enumeration | Available types for canned retract output mode

# Property Detail

## ControlPointOffset

`HoleDrillingBuilder.``ControlPointOffset`

  Returns or sets the control point offset type

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

  Getter Method

  Signature `ControlPointOffset`

  Returns: |
  Return type: | `NXOpen.CAM.HoleDrillingBuilderControlPointOffsetType`

  New in version NX10.0.2.

  License requirements: None.

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

  Setter Method

  Signature `ControlPointOffset`

  Parameters: | currentValue (`NXOpen.CAM.HoleDrillingBuilderControlPointOffsetType`) –

  New in version NX10.0.2.

  License requirements: cam_base (“CAM BASE”)

## CrossOverDistance

`HoleDrillingBuilder.``CrossOverDistance`

  Returns the crossover distance

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

  Getter Method

  Signature `CrossOverDistance`

  Returns: | the cross over distance builder
  Return type: | `NXOpen.CAM.InheritableToolDepBuilder`

  New in version NX11.0.0.

  License requirements: None.

## CutParameters

`HoleDrillingBuilder.``CutParameters`

  Returns the Hole Drilling Cut Parameters

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

  Getter Method

  Signature `CutParameters`

  Returns: | the Cut Parameters
  Return type: | `NXOpen.CAM.HoleDrillingCutParameters`

  New in version NX9.0.0.

  Deprecated since version NX9.0.3: Use `CAM.HoleMachiningBuilder.CuttingParameters()` instead.

  License requirements: None.

## IgnoreToolTip

`HoleDrillingBuilder.``IgnoreToolTip`

  Returns or sets the ignore tool tip flag

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

  Getter Method

  Signature `IgnoreToolTip`

  Returns: | the ignore tool tip flag
  Return type: | bool

  New in version NX9.0.2.

  Deprecated since version NX10.0.3: Use CAM.HoleDrillingBuilder.GetToolDrivePoint instead.

  License requirements: None.

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

  Setter Method

  Signature `IgnoreToolTip`

  Parameters: | flag (bool) – the ignore tool tip flag

  New in version NX9.0.2.

  Deprecated since version NX10.0.3: Use CAM.HoleDrillingBuilder.SetToolDrivePoint instead.

  License requirements: cam_base (“CAM BASE”)

## IntersectionStrategy

`HoleDrillingBuilder.``IntersectionStrategy`

  Returns or sets the control point offset type

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

  Getter Method

  Signature `IntersectionStrategy`

  Returns: |
  Return type: | `NXOpen.CAM.HoleDrillingBuilderIntersectionStrategyType`

  New in version NX10.0.2.

  License requirements: None.

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

  Setter Method

  Signature `IntersectionStrategy`

  Parameters: | currentValue (`NXOpen.CAM.HoleDrillingBuilderIntersectionStrategyType`) –

  New in version NX10.0.2.

  License requirements: cam_base (“CAM BASE”)

## OppositeDirection

`HoleDrillingBuilder.``OppositeDirection`

  Returns the opposite direction

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

  Getter Method

  Signature `OppositeDirection`

  Returns: | the opposite direction
  Return type: | `NXOpen.CAM.OppositeDirection`

  New in version NX9.0.0.

  Deprecated since version NX9.0.2: Change the Z-axis of the in-process feature instead.

  License requirements: None.

## RetractOutputMode

`HoleDrillingBuilder.``RetractOutputMode`

  Returns or sets the canned rettract output

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

  Getter Method

  Signature `RetractOutputMode`

  Returns: |
  Return type: | `NXOpen.CAM.HoleDrillingBuilderRetractOutputModeType`

  New in version NX9.0.3.

  License requirements: None.

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

  Setter Method

  Signature `RetractOutputMode`

  Parameters: | currentValue (`NXOpen.CAM.HoleDrillingBuilderRetractOutputModeType`) –

  New in version NX9.0.3.

  License requirements: cam_base (“CAM BASE”)

# Method Detail

## GetToolDrivePoint

`HoleDrillingBuilder.``GetToolDrivePoint`

  Get the name of the tool drive point

  Signature `GetToolDrivePoint()`

  Returns: |
  Return type: | str

  New in version NX10.0.3.

  License requirements: None.

## SetToolDrivePoint

`HoleDrillingBuilder.``SetToolDrivePoint`

  Set the name of the tool drive point

  Signature `SetToolDrivePoint(toolDrivePoint)`

  Parameters: | toolDrivePoint (str) –

  New in version NX10.0.3.

  License requirements: cam_base (“CAM BASE”)

## Validate

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