HoleBossSet Class — NXOpen Python API Reference 12.0.0 documentation

# HoleBossSet Class

class `NXOpen.CAM.``HoleBossSet`

  Bases: `NXOpen.TaggedObject`

  Represents a Cut Area Geometry builder

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

  New in version NX7.5.0.

# Properties

Property | Description
--- | ---
Depth | Returns or sets the Depth
DepthBuilder | Returns the depth builder
DepthLimit | Returns or sets the Depth Limit types
Diameter | Returns or sets the Diameter
DiameterBuilder | Returns the diameter builder
Length | Returns or sets the Length
LengthBuilder | Returns the length builder
MajorDiameter | Returns or sets the Major Diameter
MinorDiameter | Returns or sets the Minor Diameter
Size | Returns or sets the Size
StartDiameter | Returns the start diameter
Tag | Returns the Tag for this object.
TipAngle | Returns the tip angle
ToolAxis | Returns or sets the Tool Axis

# Methods

Method | Description
--- | ---
GetFeature | Returns the in process feature
GetMachiningFeature | Returns the machining feature
InferLogic | Save the infer logic information of the input entity, such as the orientation, pitch, diameter and height etc.
ReverseDirection | Reverses the direction of the feature

# Enumerations

HoleBossSetDepthLimitTypes Enumeration | the depth limit types

# Property Detail

## Depth

`HoleBossSet.``Depth`

  Returns or sets the Depth

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

  Getter Method

  Signature `Depth`

  Returns: | the Depth
  Return type: | float

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `Depth`

  Parameters: | depthValue (float) – the Depth

  New in version NX7.5.0.

  License requirements: cam_base (“CAM BASE”)

## DepthBuilder

`HoleBossSet.``DepthBuilder`

  Returns the depth builder

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

  Getter Method

  Signature `DepthBuilder`

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

  New in version NX7.5.0.

  License requirements: None.

## DepthLimit

`HoleBossSet.``DepthLimit`

  Returns or sets the Depth Limit types

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

  Getter Method

  Signature `DepthLimit`

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

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `DepthLimit`

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

  New in version NX8.0.0.

  License requirements: cam_base (“CAM BASE”)

## Diameter

`HoleBossSet.``Diameter`

  Returns or sets the Diameter

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

  Getter Method

  Signature `Diameter`

  Returns: | the Diameter
  Return type: | float

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `Diameter`

  Parameters: | holeBossValue (float) – the Diameter

  New in version NX7.5.0.

  License requirements: cam_base (“CAM BASE”)

## DiameterBuilder

`HoleBossSet.``DiameterBuilder`

  Returns the diameter builder

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

  Getter Method

  Signature `DiameterBuilder`

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

  New in version NX7.5.0.

  License requirements: None.

## Length

`HoleBossSet.``Length`

  Returns or sets the Length

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

  Getter Method

  Signature `Length`

  Returns: | the Length
  Return type: | float

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `Length`

  Parameters: | holeBossValue (float) – the Length

  New in version NX7.5.0.

  License requirements: cam_base (“CAM BASE”)

## LengthBuilder

`HoleBossSet.``LengthBuilder`

  Returns the length builder

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

  Getter Method

  Signature `LengthBuilder`

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

  New in version NX7.5.0.

  License requirements: None.

## MajorDiameter

`HoleBossSet.``MajorDiameter`

  Returns or sets the Major Diameter

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

  Getter Method

  Signature `MajorDiameter`

  Returns: | the Major Diameter
  Return type: | float

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `MajorDiameter`

  Parameters: | holeBossValue (float) – the Major Diameter

  New in version NX7.5.0.

  License requirements: cam_base (“CAM BASE”)

## MinorDiameter

`HoleBossSet.``MinorDiameter`

  Returns or sets the Minor Diameter

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

  Getter Method

  Signature `MinorDiameter`

  Returns: | the Minor Diameter
  Return type: | float

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `MinorDiameter`

  Parameters: | holeBossValue (float) – the Minor Diameter

  New in version NX7.5.0.

  License requirements: cam_base (“CAM BASE”)

## Size

`HoleBossSet.``Size`

  Returns or sets the Size

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

  Getter Method

  Signature `Size`

  Returns: | the Size
  Return type: | str

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `Size`

  Parameters: | holeBossValue (str) – the Size

  New in version NX7.5.0.

  License requirements: cam_base (“CAM BASE”)

## StartDiameter

`HoleBossSet.``StartDiameter`

  Returns the start diameter

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

  Getter Method

  Signature `StartDiameter`

  Returns: | the attribute
  Return type: | `NXOpen.CAM.CAMAttribute`

  New in version NX9.0.0.

  License requirements: None.

## TipAngle

`HoleBossSet.``TipAngle`

  Returns the tip angle

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

  Getter Method

  Signature `TipAngle`

  Returns: | the attribute
  Return type: | `NXOpen.CAM.CAMAttribute`

  New in version NX9.0.0.

  License requirements: None.

## ToolAxis

`HoleBossSet.``ToolAxis`

  Returns or sets the Tool Axis

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

  Getter Method

  Signature `ToolAxis`

  Returns: | the Tool Axis
  Return type: | `NXOpen.NXObject`

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `ToolAxis`

  Parameters: | toolAxis (`NXOpen.NXObject`) – the tool axis

  New in version NX7.5.0.

  License requirements: cam_base (“CAM BASE”)

# Method Detail

## GetFeature

`HoleBossSet.``GetFeature`

  Returns the in process feature

  Signature `GetFeature()`

  Returns: |
  Return type: | `NXOpen.CAM.FBM.Feature`

  New in version NX9.0.0.

  License requirements: None.

## GetMachiningFeature

`HoleBossSet.``GetMachiningFeature`

  Returns the machining feature

  Signature `GetMachiningFeature()`

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

  New in version NX9.0.0.

  License requirements: None.

## InferLogic

`HoleBossSet.``InferLogic`

  Save the infer logic information of the input entity, such as the orientation, pitch, diameter and height etc.

  into the feature

  Signature `InferLogic(entity)`

  Parameters: | entity (`NXOpen.NXObject`) – the geometry

  New in version NX7.5.2.

  License requirements: None.

## ReverseDirection

`HoleBossSet.``ReverseDirection`

  Reverses the direction of the feature

  Signature `ReverseDirection()`

  New in version NX8.0.0.

  License requirements: None.