HoleManufacturingNoteBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# HoleManufacturingNoteBuilder Class

class `NXOpen.Tooling.``HoleManufacturingNoteBuilder`

  Bases: `NXOpen.Builder`

  Tooling builder for HoleManufacturingNote

  To create a new instance of this class, use `NXOpen.Tooling.HoleManufacturingNoteCollection.CreateHoleManufacturingNoteBuilder()`

  Default values.

  Property | Value
  --- | ---
  DefineByViewOrHolesEnum | View
  HoleIndexSize | 3.5
  HoleIndexTypeEnum | UserDefinedAndNumber
  HoleManufacturingNoteSize | 3.5
  UseDifferentSubIndexForSameDiameterHoles | 0

  New in version NX9.0.0.

# Properties

Property | Description
--- | ---
CreatedHoleManufacturingNote | Returns or sets the created hole manufacturing note
DefineByViewOrHolesEnum | Returns or sets the selection type enumeration
HoleIndexColor | Returns or sets the hole index character color
HoleIndexSize | Returns or sets the hole index character size
HoleIndexTypeEnum | Returns or sets the hole index type enumeration
HoleManufacturingNoteColor | Returns or sets the manufaturing information character color
HoleManufacturingNoteOrigin | Returns the manufacturing information origin
HoleManufacturingNoteSize | Returns or sets the manufaturing information character size
HoleManufacturingNoteStyle | Returns the hole manufacturing note style
SelectHoles | Returns the selected holes
SelectView | Returns the selected view
Tag | Returns the Tag for this object.
UseDifferentSubIndexForSameDiameterHoles | Returns or sets the use different sub index for same diameter holes
WizardType | Returns or sets the wizard type

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
CreateHoleIndexLabel | The method to create hole index
CreateHoleManufacturingNoteAsNote | The method to create manufaturing information as note
CycleObjectsInView | The method to cycle objects in view
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.
GetObject | Returns the object currently being edited by this builder.
ModifyStyle | The method to modify the style of the previewed note
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.

# Enumerations

HoleManufacturingNoteBuilderDefineByViewOrHoles Enumeration | the view selection or window selection type
HoleManufacturingNoteBuilderHoleIndexType Enumeration | the hole index type

# Property Detail

## CreatedHoleManufacturingNote

`HoleManufacturingNoteBuilder.``CreatedHoleManufacturingNote`

  Returns or sets the created hole manufacturing note

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

  Getter Method

  Signature `CreatedHoleManufacturingNote`

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

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `CreatedHoleManufacturingNote`

  Parameters: | createdHoleManufacturingNote (`NXOpen.NXObject`) –

  New in version NX9.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## DefineByViewOrHolesEnum

`HoleManufacturingNoteBuilder.``DefineByViewOrHolesEnum`

  Returns or sets the selection type enumeration

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

  Getter Method

  Signature `DefineByViewOrHolesEnum`

  Returns: |
  Return type: | `NXOpen.Tooling.HoleManufacturingNoteBuilderDefineByViewOrHoles`

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `DefineByViewOrHolesEnum`

  Parameters: | defineByViewOrHoles (`NXOpen.Tooling.HoleManufacturingNoteBuilderDefineByViewOrHoles`) –

  New in version NX9.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## HoleIndexColor

`HoleManufacturingNoteBuilder.``HoleIndexColor`

  Returns or sets the hole index character color

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

  Getter Method

  Signature `HoleIndexColor`

  Returns: |
  Return type: | Id

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `HoleIndexColor`

  Parameters: | holeIndexColor (Id) –

  New in version NX9.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## HoleIndexSize

`HoleManufacturingNoteBuilder.``HoleIndexSize`

  Returns or sets the hole index character size

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

  Getter Method

  Signature `HoleIndexSize`

  Returns: |
  Return type: | float

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `HoleIndexSize`

  Parameters: | holeIndexSize (float) –

  New in version NX9.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## HoleIndexTypeEnum

`HoleManufacturingNoteBuilder.``HoleIndexTypeEnum`

  Returns or sets the hole index type enumeration

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

  Getter Method

  Signature `HoleIndexTypeEnum`

  Returns: |
  Return type: | `NXOpen.Tooling.HoleManufacturingNoteBuilderHoleIndexType`

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `HoleIndexTypeEnum`

  Parameters: | holeIndexTypeEnum (`NXOpen.Tooling.HoleManufacturingNoteBuilderHoleIndexType`) –

  New in version NX9.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## HoleManufacturingNoteColor

`HoleManufacturingNoteBuilder.``HoleManufacturingNoteColor`

  Returns or sets the manufaturing information character color

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

  Getter Method

  Signature `HoleManufacturingNoteColor`

  Returns: |
  Return type: | Id

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `HoleManufacturingNoteColor`

  Parameters: | holeManufacturingNoteColor (Id) –

  New in version NX9.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## HoleManufacturingNoteOrigin

`HoleManufacturingNoteBuilder.``HoleManufacturingNoteOrigin`

  Returns the manufacturing information origin

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

  Getter Method

  Signature `HoleManufacturingNoteOrigin`

  Returns: |
  Return type: | `NXOpen.Annotations.OriginBuilder`

  New in version NX9.0.0.

  License requirements: None.

## HoleManufacturingNoteSize

`HoleManufacturingNoteBuilder.``HoleManufacturingNoteSize`

  Returns or sets the manufaturing information character size

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

  Getter Method

  Signature `HoleManufacturingNoteSize`

  Returns: |
  Return type: | float

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `HoleManufacturingNoteSize`

  Parameters: | holeManufacturingNoteSize (float) –

  New in version NX9.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## HoleManufacturingNoteStyle

`HoleManufacturingNoteBuilder.``HoleManufacturingNoteStyle`

  Returns the hole manufacturing note style

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

  Getter Method

  Signature `HoleManufacturingNoteStyle`

  Returns: |
  Return type: | `NXOpen.Annotations.StyleBuilder`

  New in version NX9.0.0.

  License requirements: None.

## SelectHoles

`HoleManufacturingNoteBuilder.``SelectHoles`

  Returns the selected holes

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

  Getter Method

  Signature `SelectHoles`

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

  New in version NX9.0.0.

  License requirements: None.

## SelectView

`HoleManufacturingNoteBuilder.``SelectView`

  Returns the selected view

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

  Getter Method

  Signature `SelectView`

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

  New in version NX9.0.0.

  License requirements: None.

## UseDifferentSubIndexForSameDiameterHoles

`HoleManufacturingNoteBuilder.``UseDifferentSubIndexForSameDiameterHoles`

  Returns or sets the use different sub index for same diameter holes

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

  Getter Method

  Signature `UseDifferentSubIndexForSameDiameterHoles`

  Returns: |
  Return type: | bool

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `UseDifferentSubIndexForSameDiameterHoles`

  Parameters: | useDifferentSubIndexForSameDiameterHoles (bool) –

  New in version NX11.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## WizardType

`HoleManufacturingNoteBuilder.``WizardType`

  Returns or sets the wizard type

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

  Getter Method

  Signature `WizardType`

  Returns: |
  Return type: | int

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `WizardType`

  Parameters: | wizardType (int) –

  New in version NX9.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

# Method Detail

## CreateHoleIndexLabel

`HoleManufacturingNoteBuilder.``CreateHoleIndexLabel`

  The method to create hole index

  Signature `CreateHoleIndexLabel(viewTag, holeTypeIndex, faceTag, holeDiameter, holePos, holetype, reverseFlag)`

  Parameters:

  - viewTag (`NXOpen.NXObject`) – The view to create hole index label
  - holeTypeIndex (str) – The hole hole index label string
  - faceTag (`NXOpen.NXObject`) – The hole face data
  - holeDiameter (float) – The hole diameter
  - holePos (`NXOpen.Point3d`) – The hole position
  - holetype (str) – The hole type string
  - reverseFlag (bool) – The hole reversed flag

  Returns: | The hole index label tag
  Return type: | `NXOpen.NXObject`

  New in version NX9.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## CreateHoleManufacturingNoteAsNote

`HoleManufacturingNoteBuilder.``CreateHoleManufacturingNoteAsNote`

  The method to create manufaturing information as note

  Signature `CreateHoleManufacturingNoteAsNote(viewTag, holeManufacturingNoteVector, point)`

  Parameters:

  - viewTag (`NXOpen.NXObject`) – The view to create hole index label
  - holeManufacturingNoteVector (list of str) – The hole index label string
  - point (`NXOpen.Point3d`) – The location point data

  Returns: | The manufaturing information note tag
  Return type: | `NXOpen.NXObject`

  New in version NX9.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## CycleObjectsInView

`HoleManufacturingNoteBuilder.``CycleObjectsInView`

  The method to cycle objects in view

  Signature `CycleObjectsInView(viewTag, vseqNumber, isDrawing, inObject)`

  Parameters:

  - viewTag (`NXOpen.NXObject`) – The view to cycle
  - vseqNumber (int) – The View Sequence Number of the View must NOT be DSS_ALL_VIEWS or DSS_NO_VIEWS
  - isDrawing (bool) – Is this view a drawing
  - inObject (`NXOpen.NXObject`) – Input object

  Returns: | Output object
  Return type: | `NXOpen.NXObject`

  New in version NX9.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## ModifyStyle

`HoleManufacturingNoteBuilder.``ModifyStyle`

  The method to modify the style of the previewed note

  Signature `ModifyStyle()`

  New in version NX9.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## Validate

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