NcmHoleMachining Class — NXOpen Python API Reference 12.0.0 documentation

# NcmHoleMachining Class

class `NXOpen.CAM.``NcmHoleMachining`

  Bases: `NXOpen.CAM.NcmSubopBuilder`

  Represents a `NXOpen.CAM.NcmHoleMachining`

  New in version NX7.5.0.

# Properties

Property | Description
--- | ---
CollisionCheck | Returns or sets the collision check activation
CutcomMinimumAngle | Returns or sets the cutter compensation minimum angle
CutcomMinimumMove | Returns the cutter compensation minimum move builder (inheritable tool dep)
CutcomOutputContactPoint | Returns or sets the cutter compensation output contact point status
CutcomOutputPlane | Returns or sets the cutter compensation output plane status
CutcomType | Returns or sets the cutter compensation type
DefaultRegionStartType | Returns or sets the region start type
Engage | Returns the engage settings
FinalRetract | Returns the final retract settings
FinalSafeDistance | Returns the final safe distance builder (inheritable tool dep)
FinalType | Returns or sets the final type
InitialEngage | Returns the initial engage settings
InitialSafeDistance | Returns the initial safe distance builder (inheritable tool dep)
InitialType | Returns or sets the initial type
NcmSmoothing | Returns the non cutting smoothing
NumberOfThreads | Returns or sets the number of threads
OverlapAngle | Returns or sets the overlap angle
OverlapDistance | Returns or sets the overlap distance
OverlapType | Returns or sets the region start type
RegionStartAngle | Returns or sets the region start angle
Retract | Returns the retract settings
StartFromCenter | Returns or sets the start from center
StartPointsEffectDistBuilder | Returns the region start points effective distance builder (inheritable tool dep)
StartPointsUseEffectDist | Returns or sets the start points use effective distance
SuppressCutcom | Returns or sets the suppress cutter compensation
Tag | Returns the Tag for this object.
TrackingData | Returns or sets the tracking data (tracking point type)
TransferAvoidanceFrom | Returns the from point builder
TransferAvoidanceGohome | Returns the gohome point builder
TransferAvoidanceReturn | Returns the return point builder
TransferAvoidanceStart | Returns the start point builder
TransferBetweenRegions | Returns the transfer between regions
TransferClearance | Returns the clearance setting
TransferInitialFinal | Returns the transfer settings for initial and final

# Methods

Method | Description
--- | ---
GetCustomizableItemBuilder | Returns the customizable item builder for given customizable item name
GetCustomizableItemNames | Returns the names for all customizable item ids
GetRegionStartPoints | Returns region start points
SetRegionStartPoints | Sets region start points
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

NcmHoleMachiningCutcomTypes Enumeration | Available types for cutter compensation in hole machining
NcmHoleMachiningFinalTypes Enumeration | Available types for final clearance in hole machining
NcmHoleMachiningInitialTypes Enumeration | Available types for initial clearance in hole machining
NcmHoleMachiningOverlapTypes Enumeration | Available types for overlap types

# Property Detail

## CollisionCheck

`NcmHoleMachining.``CollisionCheck`

  Returns or sets the collision check activation

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

  Getter Method

  Signature `CollisionCheck`

  Returns: |
  Return type: | bool

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `CollisionCheck`

  Parameters: | newValue (bool) –

  New in version NX9.0.0.

  License requirements: cam_base (“CAM BASE”)

## CutcomMinimumAngle

`NcmHoleMachining.``CutcomMinimumAngle`

  Returns or sets the cutter compensation minimum angle

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

  Getter Method

  Signature `CutcomMinimumAngle`

  Returns: |
  Return type: | float

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `CutcomMinimumAngle`

  Parameters: | minimumAngle (float) –

  New in version NX7.5.0.

  License requirements: cam_base (“CAM BASE”)

## CutcomMinimumMove

`NcmHoleMachining.``CutcomMinimumMove`

  Returns the cutter compensation minimum move builder (inheritable tool dep)

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

  Getter Method

  Signature `CutcomMinimumMove`

  Returns: | The cutcom minimum move builder
  Return type: | `NXOpen.CAM.InheritableToolDepBuilder`

  New in version NX7.5.0.

  License requirements: None.

## CutcomOutputContactPoint

`NcmHoleMachining.``CutcomOutputContactPoint`

  Returns or sets the cutter compensation output contact point status

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

  Getter Method

  Signature `CutcomOutputContactPoint`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `CutcomOutputContactPoint`

  Parameters: | newValue (bool) –

  New in version NX7.5.0.

  License requirements: cam_base (“CAM BASE”)

## CutcomOutputPlane

`NcmHoleMachining.``CutcomOutputPlane`

  Returns or sets the cutter compensation output plane status

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

  Getter Method

  Signature `CutcomOutputPlane`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `CutcomOutputPlane`

  Parameters: | outputPlane (bool) –

  New in version NX7.5.0.

  License requirements: cam_base (“CAM BASE”)

## CutcomType

`NcmHoleMachining.``CutcomType`

  Returns or sets the cutter compensation type

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

  Getter Method

  Signature `CutcomType`

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

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `CutcomType`

  Parameters: | cutcomType (`NXOpen.CAM.NcmHoleMachiningCutcomTypes`) –

  New in version NX7.5.0.

  License requirements: cam_base (“CAM BASE”)

## Engage

`NcmHoleMachining.``Engage`

  Returns the engage settings

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

  Getter Method

  Signature `Engage`

  Returns: | The engage builder
  Return type: | `NXOpen.CAM.NcmHoleMachiningEngRet`

  New in version NX7.5.0.

  License requirements: None.

## FinalRetract

`NcmHoleMachining.``FinalRetract`

  Returns the final retract settings

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

  Getter Method

  Signature `FinalRetract`

  Returns: | The final retract builder
  Return type: | `NXOpen.CAM.NcmHoleMachiningEngRet`

  New in version NX7.5.0.

  License requirements: None.

## FinalSafeDistance

`NcmHoleMachining.``FinalSafeDistance`

  Returns the final safe distance builder (inheritable tool dep)

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

  Getter Method

  Signature `FinalSafeDistance`

  Returns: | The final safe distance builder
  Return type: | `NXOpen.CAM.InheritableToolDepBuilder`

  New in version NX7.5.0.

  License requirements: None.

## FinalType

`NcmHoleMachining.``FinalType`

  Returns or sets the final type

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

  Getter Method

  Signature `FinalType`

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

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `FinalType`

  Parameters: | finalType (`NXOpen.CAM.NcmHoleMachiningFinalTypes`) –

  New in version NX7.5.0.

  License requirements: cam_base (“CAM BASE”)

## InitialEngage

`NcmHoleMachining.``InitialEngage`

  Returns the initial engage settings

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

  Getter Method

  Signature `InitialEngage`

  Returns: | The initial engage
  Return type: | `NXOpen.CAM.NcmHoleMachiningEngRet`

  New in version NX7.5.0.

  License requirements: None.

## InitialSafeDistance

`NcmHoleMachining.``InitialSafeDistance`

  Returns the initial safe distance builder (inheritable tool dep)

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

  Getter Method

  Signature `InitialSafeDistance`

  Returns: | The initial safe distance builder
  Return type: | `NXOpen.CAM.InheritableToolDepBuilder`

  New in version NX7.5.0.

  License requirements: None.

## InitialType

`NcmHoleMachining.``InitialType`

  Returns or sets the initial type

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

  Getter Method

  Signature `InitialType`

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

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `InitialType`

  Parameters: | initialType (`NXOpen.CAM.NcmHoleMachiningInitialTypes`) –

  New in version NX7.5.0.

  License requirements: cam_base (“CAM BASE”)

## NcmSmoothing

`NcmHoleMachining.``NcmSmoothing`

  Returns the non cutting smoothing

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

  Getter Method

  Signature `NcmSmoothing`

  Returns: | The non cutting smoothing
  Return type: | `NXOpen.CAM.NcmSmoothingBuilder`

  New in version NX10.0.3.

  License requirements: None.

## NumberOfThreads

`NcmHoleMachining.``NumberOfThreads`

  Returns or sets the number of threads

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

  Getter Method

  Signature `NumberOfThreads`

  Returns: |
  Return type: | float

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `NumberOfThreads`

  Parameters: | numberOfThreads (float) –

  New in version NX7.5.0.

  License requirements: cam_base (“CAM BASE”)

## OverlapAngle

`NcmHoleMachining.``OverlapAngle`

  Returns or sets the overlap angle

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

  Getter Method

  Signature `OverlapAngle`

  Returns: |
  Return type: | float

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `OverlapAngle`

  Parameters: | overlapAngle (float) –

  New in version NX7.5.0.

  License requirements: cam_base (“CAM BASE”)

## OverlapDistance

`NcmHoleMachining.``OverlapDistance`

  Returns or sets the overlap distance

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

  Getter Method

  Signature `OverlapDistance`

  Returns: |
  Return type: | float

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `OverlapDistance`

  Parameters: | overlapDistance (float) –

  New in version NX7.5.0.

  License requirements: cam_base (“CAM BASE”)

## OverlapType

`NcmHoleMachining.``OverlapType`

  Returns or sets the region start type

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

  Getter Method

  Signature `OverlapType`

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

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `OverlapType`

  Parameters: | overlapType (`NXOpen.CAM.NcmHoleMachiningOverlapTypes`) –

  New in version NX7.5.0.

  License requirements: cam_base (“CAM BASE”)

## RegionStartAngle

`NcmHoleMachining.``RegionStartAngle`

  Returns or sets the region start angle

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

  Getter Method

  Signature `RegionStartAngle`

  Returns: |
  Return type: | float

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `RegionStartAngle`

  Parameters: | regionStartAngle (float) –

  New in version NX7.5.0.

  License requirements: cam_base (“CAM BASE”)

## Retract

`NcmHoleMachining.``Retract`

  Returns the retract settings

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

  Getter Method

  Signature `Retract`

  Returns: | The retract builder
  Return type: | `NXOpen.CAM.NcmHoleMachiningEngRet`

  New in version NX7.5.0.

  License requirements: None.

## StartFromCenter

`NcmHoleMachining.``StartFromCenter`

  Returns or sets the start from center

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

  Getter Method

  Signature `StartFromCenter`

  Returns: | the start from center
  Return type: | bool

  New in version NX7.5.5.

  License requirements: None.

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

  Setter Method

  Signature `StartFromCenter`

  Parameters: | startFromCenter (bool) – the start from center

  New in version NX7.5.5.

  License requirements: cam_base (“CAM BASE”)

## SuppressCutcom

`NcmHoleMachining.``SuppressCutcom`

  Returns or sets the suppress cutter compensation

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

  Getter Method

  Signature `SuppressCutcom`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `SuppressCutcom`

  Parameters: | suppressCutcom (bool) –

  New in version NX7.5.0.

  License requirements: cam_base (“CAM BASE”)

## TrackingData

`NcmHoleMachining.``TrackingData`

  Returns or sets the tracking data (tracking point type)

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

  Getter Method

  Signature `TrackingData`

  Returns: | tracking data
  Return type: | str

  New in version NX9.0.2.

  License requirements: None.

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

  Setter Method

  Signature `TrackingData`

  Parameters: | trackingData (str) – tracking data

  New in version NX9.0.2.

  License requirements: cam_base (“CAM BASE”)

## TransferAvoidanceFrom

`NcmHoleMachining.``TransferAvoidanceFrom`

  Returns the from point builder

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

  Getter Method

  Signature `TransferAvoidanceFrom`

  Returns: | The from point builder
  Return type: | `NXOpen.CAM.NcmAvoidancePointBuilder`

  New in version NX7.5.0.

  License requirements: None.

## TransferAvoidanceGohome

`NcmHoleMachining.``TransferAvoidanceGohome`

  Returns the gohome point builder

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

  Getter Method

  Signature `TransferAvoidanceGohome`

  Returns: | The gohome point builder
  Return type: | `NXOpen.CAM.NcmAvoidancePointBuilder`

  New in version NX7.5.0.

  License requirements: None.

## TransferAvoidanceReturn

`NcmHoleMachining.``TransferAvoidanceReturn`

  Returns the return point builder

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

  Getter Method

  Signature `TransferAvoidanceReturn`

  Returns: | The return point builder
  Return type: | `NXOpen.CAM.NcmAvoidancePointBuilder`

  New in version NX7.5.0.

  License requirements: None.

## TransferAvoidanceStart

`NcmHoleMachining.``TransferAvoidanceStart`

  Returns the start point builder

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

  Getter Method

  Signature `TransferAvoidanceStart`

  Returns: | The start point builder
  Return type: | `NXOpen.CAM.NcmAvoidancePointBuilder`

  New in version NX7.5.0.

  License requirements: None.

## TransferBetweenRegions

`NcmHoleMachining.``TransferBetweenRegions`

  Returns the transfer between regions

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

  Getter Method

  Signature `TransferBetweenRegions`

  Returns: | Transfer Between Regions
  Return type: | `NXOpen.CAM.NcmTransfer`

  New in version NX9.0.0.

  License requirements: None.

## TransferClearance

`NcmHoleMachining.``TransferClearance`

  Returns the clearance setting

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

  Getter Method

  Signature `TransferClearance`

  Returns: | The clearance builder
  Return type: | `NXOpen.CAM.NcmClearanceBuilder`

  New in version NX7.5.0.

  License requirements: None.

## TransferInitialFinal

`NcmHoleMachining.``TransferInitialFinal`

  Returns the transfer settings for initial and final

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

  Getter Method

  Signature `TransferInitialFinal`

  Returns: | The transfer builder
  Return type: | `NXOpen.CAM.NcmTransferBuilder`

  New in version NX7.5.0.

  License requirements: None.

# Method Detail

## Validate

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