DrillGeomBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# DrillGeomBuilder Class

class `NXOpen.CAM.``DrillGeomBuilder`

  Bases: `NXOpen.CAM.FeatureGeomBuilder`

  Represents a DrillGeom Builder

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

  New in version NX5.0.0.

# Properties

Property | Description
--- | ---
BlankOffsetBuilder | Returns the blank offset (inheritable double)
BottomSurface | Returns the bottom surface builder
CheckOffsetBuilder | Returns the check offset (inheritable double)
CycleEvent | Returns the cycle event
CycleTable | Returns the cycle
Description | Returns or sets the description
EndUdeSet | Returns the end ude set
GeometryCiBuilder | Returns the geometry builder
LayoutCiBuilder | Returns the save/layer layout builder
OptimizationMethod | Returns or sets the optim method
PartMaterialBuilder | Returns or sets the part material
PartOffsetBuilder | Returns the part offset (inheritable double)
StartUdeSet | Returns the start ude set
Tag | Returns the Tag for this object.
ToolAxisAsArcAxis | Returns or sets the Tool Axis as Arc Axis
ToolAxisVector | Returns or sets the Tool Axis vector
TopSurface | Returns the top surface builder
TrimOffsetBuilder | Returns the trim offset (inheritable double)

# 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 part material
GetMaterialData | Get material data
GetObject | Returns the object currently being edited by this builder.
GetToolAxisType | Returns the Tool Axis type
SetMaterial | Set part material
SetToolAxisType | Sets the Tool Axis type
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.

# Property Detail

## BottomSurface

`DrillGeomBuilder.``BottomSurface`

  Returns the bottom surface builder

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

  Getter Method

  Signature `BottomSurface`

  Returns: | The bottom surface builder
  Return type: | `NXOpen.CAM.DrillSurfaceBuilder`

  New in version NX7.5.0.

  License requirements: None.

## ToolAxisAsArcAxis

`DrillGeomBuilder.``ToolAxisAsArcAxis`

  Returns or sets the Tool Axis as Arc Axis

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

  Getter Method

  Signature `ToolAxisAsArcAxis`

  Returns: | the current toggle value
  Return type: | int

  New in version NX5.0.0.

  License requirements: cam_base (“CAM BASE”)

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

  Setter Method

  Signature `ToolAxisAsArcAxis`

  Parameters: | toggleValue (int) – the new toggle value

  New in version NX5.0.0.

  License requirements: cam_base (“CAM BASE”)

## ToolAxisVector

`DrillGeomBuilder.``ToolAxisVector`

  Returns or sets the Tool Axis vector

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

  Getter Method

  Signature `ToolAxisVector`

  Returns: | the vector tag
  Return type: | `NXOpen.NXObject`

  New in version NX5.0.0.

  License requirements: cam_base (“CAM BASE”)

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

  Setter Method

  Signature `ToolAxisVector`

  Parameters: | vector (`NXOpen.NXObject`) – the vector tag

  New in version NX5.0.0.

  License requirements: cam_base (“CAM BASE”)

## TopSurface

`DrillGeomBuilder.``TopSurface`

  Returns the top surface builder

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

  Getter Method

  Signature `TopSurface`

  Returns: | The top surface builder
  Return type: | `NXOpen.CAM.DrillSurfaceBuilder`

  New in version NX7.5.0.

  License requirements: None.

# Method Detail

## GetToolAxisType

`DrillGeomBuilder.``GetToolAxisType`

  Returns the Tool Axis type

  Signature `GetToolAxisType()`

  Returns: | the integer value
  Return type: | int

  New in version NX5.0.0.

  License requirements: cam_base (“CAM BASE”)

## SetToolAxisType

`DrillGeomBuilder.``SetToolAxisType`

  Sets the Tool Axis type

  Signature `SetToolAxisType(value)`

  Parameters: | value (int) – the integer value

  New in version NX5.0.0.

  License requirements: cam_base (“CAM BASE”)

## Validate

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