HoleBossGeom Class — NXOpen Python API Reference 12.0.0 documentation

# HoleBossGeom Class

class `NXOpen.CAM.``HoleBossGeom`

  Bases: `NXOpen.TaggedObject`

  Represents a CAM geometry builder

  This is an abstract class and cannot be instantiated.

  New in version NX7.5.0.

# Properties

Property | Description
--- | ---
BossList | Returns the boss list
DepthLimit | Returns or sets the Depth Limit types
FormAndPitch | Returns or sets the Form and Pitch types
HoleBossGeomType | Returns or sets the hole or boss types
HoleList | Returns the hole list
Optimization | Returns or sets the optimization types
Pitch | Returns or sets the Pitch
Rotation | Returns or sets the Rotation types
Selection | Returns the selection geometry
Tag | Returns the Tag for this object.
ThreadedBossList | Returns the threaded boss list
ThreadedHoleList | Returns the threaded hole list

# Methods

Method | Description
--- | ---
CreateHoleBossBuilder | Create a new Hole or Boss
CreateThreadedBossBuilder | Create a new Thread Boss
CreateThreadedHoleBuilder | Create a new Thread Hole
GetCenterHoleGeometry | Get the center hole builder
GetChamferHoleGeometry | Get the chamfer hole builder
GetForm | The Form types.
ReorderList | Reverses the direction of the feature
SetForm | The Form types.

# Enumerations

HoleBossGeomDepthLimitTypes Enumeration | the depth limit types
HoleBossGeomFormPitchTypes Enumeration | the form and pitch types
HoleBossGeomFormTypes Enumeration | the Form types
HoleBossGeomHoleBossTypes Enumeration | the hole or boss types
HoleBossGeomOptimizationTypes Enumeration | the optimization types
HoleBossGeomRotationTypes Enumeration | the rotation types

# Property Detail

## BossList

`HoleBossGeom.``BossList`

  Returns the boss list

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

  Getter Method

  Signature `BossList`

  Returns: | the boss set object
  Return type: | `NXOpen.CAM.HoleBossSetList`

  New in version NX8.0.0.

  License requirements: None.

## DepthLimit

`HoleBossGeom.``DepthLimit`

  Returns or sets the Depth Limit types

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

  Getter Method

  Signature `DepthLimit`

  Returns: | the Depth Limit type
  Return type: | `NXOpen.CAM.HoleBossGeomDepthLimitTypes`

  New in version NX7.5.0.

  Deprecated since version NX8.0.0: Use `NXOpen.CAM.HoleBossSet.DepthLimit()` instead.

  License requirements: None.

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

  Setter Method

  Signature `DepthLimit`

  Parameters: | type (`NXOpen.CAM.HoleBossGeomDepthLimitTypes`) – the Depth Limit type

  New in version NX7.5.0.

  Deprecated since version NX8.0.0: Use `NXOpen.CAM.HoleBossSet.DepthLimit()` instead.

  License requirements: cam_base (“CAM BASE”)

## FormAndPitch

`HoleBossGeom.``FormAndPitch`

  Returns or sets the Form and Pitch types

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

  Getter Method

  Signature `FormAndPitch`

  Returns: | the Form and Pitch type
  Return type: | `NXOpen.CAM.HoleBossGeomFormPitchTypes`

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `FormAndPitch`

  Parameters: | type (`NXOpen.CAM.HoleBossGeomFormPitchTypes`) – the Form and Pitch type

  New in version NX7.5.0.

  License requirements: cam_base (“CAM BASE”)

## HoleBossGeomType

`HoleBossGeom.``HoleBossGeomType`

  Returns or sets the hole or boss types

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

  Getter Method

  Signature `HoleBossGeomType`

  Returns: | the hole boss type
  Return type: | `NXOpen.CAM.HoleBossGeomHoleBossTypes`

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `HoleBossGeomType`

  Parameters: | type (`NXOpen.CAM.HoleBossGeomHoleBossTypes`) – the hole boss type

  New in version NX7.5.0.

  License requirements: cam_base (“CAM BASE”)

## HoleList

`HoleBossGeom.``HoleList`

  Returns the hole list

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

  Getter Method

  Signature `HoleList`

  Returns: | the hole set object
  Return type: | `NXOpen.CAM.HoleBossSetList`

  New in version NX8.0.0.

  License requirements: None.

## Optimization

`HoleBossGeom.``Optimization`

  Returns or sets the optimization types

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

  Getter Method

  Signature `Optimization`

  Returns: | the optimization type
  Return type: | `NXOpen.CAM.HoleBossGeomOptimizationTypes`

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Optimization`

  Parameters: | type (`NXOpen.CAM.HoleBossGeomOptimizationTypes`) – the optimization type

  New in version NX8.0.0.

  License requirements: cam_base (“CAM BASE”)

## Pitch

`HoleBossGeom.``Pitch`

  Returns or sets the Pitch

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

  Getter Method

  Signature `Pitch`

  Returns: | the Pitch
  Return type: | float

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `Pitch`

  Parameters: | holeBossValue (float) – the Pitch

  New in version NX7.5.0.

  License requirements: cam_base (“CAM BASE”)

## Rotation

`HoleBossGeom.``Rotation`

  Returns or sets the Rotation types

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

  Getter Method

  Signature `Rotation`

  Returns: | the Rotation type
  Return type: | `NXOpen.CAM.HoleBossGeomRotationTypes`

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `Rotation`

  Parameters: | type (`NXOpen.CAM.HoleBossGeomRotationTypes`) – the Rotation type

  New in version NX7.5.0.

  License requirements: cam_base (“CAM BASE”)

## Selection

`HoleBossGeom.``Selection`

  Returns the selection geometry

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

  Getter Method

  Signature `Selection`

  Returns: |
  Return type: | `NXOpen.SelectTaggedObject`

  New in version NX7.5.0.

  License requirements: None.

## ThreadedBossList

`HoleBossGeom.``ThreadedBossList`

  Returns the threaded boss list

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

  Getter Method

  Signature `ThreadedBossList`

  Returns: | the threaded boss set object
  Return type: | `NXOpen.CAM.ThreadedBossSetList`

  New in version NX7.5.0.

  License requirements: None.

## ThreadedHoleList

`HoleBossGeom.``ThreadedHoleList`

  Returns the threaded hole list

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

  Getter Method

  Signature `ThreadedHoleList`

  Returns: | the threaded hole set object
  Return type: | `NXOpen.CAM.ThreadedHoleSetList`

  New in version NX7.5.0.

  License requirements: None.

# Method Detail

## CreateHoleBossBuilder

`HoleBossGeom.``CreateHoleBossBuilder`

  Create a new Hole or Boss

  Signature `CreateHoleBossBuilder(entities, diameter, depth, toolAxis, depthLimit)`

  Parameters:

  - entities (list of `NXOpen.NXObject`) – the geometry
  - diameter (float) – the diameter
  - depth (float) – the depth
  - toolAxis (`NXOpen.NXObject`) – the tool axis
  - depthLimit (int) – the depth limit

  Returns: | the Hole or Boss Set builder
  Return type: | `NXOpen.CAM.HoleBossSet`

  New in version NX8.0.0.

  License requirements: cam_base (“CAM BASE”)

## CreateThreadedBossBuilder

`HoleBossGeom.``CreateThreadedBossBuilder`

  Create a new Thread Boss

  Signature `CreateThreadedBossBuilder(entities, diameter, height, toolAxis, majorDiameter, minorDiameter, lengh, size, pitch, rotation, form, formUserDefined)`

  Parameters:

  - entities (list of `NXOpen.NXObject`) – the geometry
  - diameter (float) – the diameter
  - height (float) – the height
  - toolAxis (`NXOpen.NXObject`) – the tool axis
  - majorDiameter (float) – the major diameter
  - minorDiameter (float) – the minor diameter
  - lengh (float) – the lengh
  - size (str) – the size title
  - pitch (float) – the pitch
  - rotation (int) – the rotation
  - form (`NXOpen.CAM.HoleBossGeomFormTypes`) – the form
  - formUserDefined (str) – the user defined Form

  Returns: | the Thread Boss Set builder
  Return type: | `NXOpen.CAM.ThreadedBossSet`

  New in version NX7.5.0.

  License requirements: cam_base (“CAM BASE”)

## CreateThreadedHoleBuilder

`HoleBossGeom.``CreateThreadedHoleBuilder`

  Create a new Thread Hole

  Signature `CreateThreadedHoleBuilder(entities, tapDrillSize, depth, toolAxis, majorDiameter, minorDiameter, lengh, size, radialEngage, pitch, rotation, form, formUserDefined, tableStandard, depthLimit)`

  Parameters:

  - entities (list of `NXOpen.NXObject`) – the geometry
  - tapDrillSize (float) – the tap drill size
  - depth (float) – the depth
  - toolAxis (`NXOpen.NXObject`) – the tool axis
  - majorDiameter (float) – the major diameter
  - minorDiameter (float) – the minor diameter
  - lengh (float) – the lengh
  - size (str) – the size
  - radialEngage (str) – the radial engage
  - pitch (float) – the pitch
  - rotation (int) – the rotation
  - form (`NXOpen.CAM.HoleBossGeomFormTypes`) – the form
  - formUserDefined (str) – the user defined Form
  - tableStandard (str) – the Standard
  - depthLimit (int) – the depth limit

  Returns: | the Thread Hole Set builder
  Return type: | `NXOpen.CAM.ThreadedHoleSet`

  New in version NX7.5.0.

  License requirements: cam_base (“CAM BASE”)

## GetCenterHoleGeometry

`HoleBossGeom.``GetCenterHoleGeometry`

  Get the center hole builder

  Signature `GetCenterHoleGeometry()`

  Returns: | the center hole builder
  Return type: | `NXOpen.CAM.FBM.MachiningFeatureGeometry`

  New in version NX9.0.0.

  License requirements: cam_base (“CAM BASE”)

## GetChamferHoleGeometry

`HoleBossGeom.``GetChamferHoleGeometry`

  Get the chamfer hole builder

  Signature `GetChamferHoleGeometry()`

  Returns: | the center hole builder
  Return type: | `NXOpen.CAM.FBM.MachiningFeatureGeometry`

  New in version NX9.0.0.

  License requirements: cam_base (“CAM BASE”)

## GetForm

`HoleBossGeom.``GetForm`

  The Form types.

  When the Form type is user defined, it will return the Form type(UserDefined) and User Defined Name; When the Form type is NOT user defined, it will return the Form type and the formCustom is NULL.

  Signature `GetForm()`

  Returns: | a tuple
  Return type: | A tuple consisting of (type, formCustom). type is a `NXOpen.CAM.HoleBossGeomFormTypes`. the Form Standard type formCustom is a str. the User Defined Form

  New in version NX7.5.0.

  License requirements: None.

## ReorderList

`HoleBossGeom.``ReorderList`

  Reverses the direction of the feature

  Signature `ReorderList()`

  New in version NX8.0.0.

  License requirements: None.

## SetForm

`HoleBossGeom.``SetForm`

  The Form types.

  When the Form type is user defined, please set the Form type(UserDefined) and User Defined Name; When the Form type is NOT user defined, please set the Form type and let the formCustom NULL.

  Signature `SetForm(type, formCustom)`

  Parameters:

  - type (`NXOpen.CAM.HoleBossGeomFormTypes`) – the Form Standard type
  - formCustom (str) – the User Defined Form

  New in version NX7.5.0.

  License requirements: cam_base (“CAM BASE”)