NormalCutoutBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# NormalCutoutBuilder Class

class `NXOpen.Features.SheetMetal.``NormalCutoutBuilder`

  Bases: `NXOpen.Features.SheetMetal.SheetmetalBaseBuilder`

  Represents a NormalCutout feature builder.

  To create a new instance of this class, use `NXOpen.Features.SheetMetal.SheetmetalManager.CreateNormalCutoutFeatureBuilder()`

  New in version NX4.0.0.

# Properties

Property | Description
--- | ---
CutType | Returns or sets the cut type for the normal cutout.
Depth | Returns the depth of the cutout.
DepthSide | Returns or sets the depth side for the normal cutout.
DepthType | Returns or sets the depth type for the normal cutout.
From | Returns or sets the face or datum plane from which the cutout begins.
ParentFeatureInternal | Returns or sets whether or not the latest timestamped parent feature of this feature should be made internal
PatchSolutionFlag | Returns or sets the patch solution flag
PatchSurfaceFilename | Returns or sets the patch surface filename
Section | Returns or sets the section used by the normal cutout.
SectionSide | Returns or sets the side of the section that the normal cutout removes material.
Sketch | Returns or sets the internal sketch used by the normal cutout, if it exists.
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename
Tag | Returns the Tag for this object.
TargetBody | Returns or sets the target body on which the normal cutout is created.
To | Returns or sets the face or datum plane at which the cutout ends.
Type | Returns or sets the type for the normal cutout.

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
CommitFeature | Commits the feature parameters and creates the feature
Destroy | Deletes the builder, and cleans up any objects created by the builder.
GetApplicationContext | Get the application context.
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit.
GetFeature | Returns the feature currently being edited by this builder.
GetObject | Returns the object currently being edited by this builder.
HideInternalParentFeatureAfterEdit | Re-suppress an internal parent feature (a slave feature) after it has been edited.
SetApplicationContext | Set the application context.
SetDepth |
SetParentFeatureInternal | Set the parent features which would be internal or slaves to the feature being created or commited
ShowInternalParentFeatureForEdit | Unsuppress an internal parent feature (a slave feature) so it can be edited.
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
UnsetParentFeatureInternal | Set the internal parent feature of the feature being edited to external
Validate | Validate whether the inputs to the component are sufficient for commit to be called.
ValidateBuilderData | Verify that the builder data is valid for creating a normal cutout.

# Enumerations

NormalCutoutBuilderCutTypeOptions Enumeration | This enum represents the cut type for the normal cutout.
NormalCutoutBuilderDepthSideOptions Enumeration | This enum represents the depth direction for the normal cutout.
NormalCutoutBuilderDepthTypeOptions Enumeration | This enum represents the depth type for the normal cutout.
NormalCutoutBuilderSectionSideOptions Enumeration | This enum represents the side of the section that the normal cutout removes material.
NormalCutoutBuilderTypeOptions Enumeration | Represents the type of the normal cutout - sketch type OR 3D-curve type

# Property Detail

## CutType

`NormalCutoutBuilder.``CutType`

  Returns or sets the cut type for the normal cutout.

  The options are in `NXOpen.Features.SheetMetal.NormalCutoutBuilderCutTypeOptions`.

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

  Getter Method

  Signature `CutType`

  Returns: |
  Return type: | `NXOpen.Features.SheetMetal.NormalCutoutBuilderCutTypeOptions`

  New in version NX4.0.0.

  License requirements: nx_sheet_metal (“NX Sheet Metal”) OR nx_flexible_pcb (“NX Flexible PCB”)

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

  Setter Method

  Signature `CutType`

  Parameters: | cutType (`NXOpen.Features.SheetMetal.NormalCutoutBuilderCutTypeOptions`) –

  New in version NX4.0.0.

  License requirements: nx_sheet_metal (“NX Sheet Metal”) OR nx_flexible_pcb (“NX Flexible PCB”)

## Depth

`NormalCutoutBuilder.``Depth`

  Returns the depth of the cutout.

  Only applies when the depth type is `NXOpen.Features.SheetMetal.NormalCutoutBuilderDepthTypeOptions.Finite`.

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

  Getter Method

  Signature `Depth`

  Returns: | The depth of the normal cutout
  Return type: | `NXOpen.Expression`

  New in version NX4.0.0.

  License requirements: nx_sheet_metal (“NX Sheet Metal”) OR nx_flexible_pcb (“NX Flexible PCB”)

## DepthSide

`NormalCutoutBuilder.``DepthSide`

  Returns or sets the depth side for the normal cutout.

  The options are in `NXOpen.Features.SheetMetal.NormalCutoutBuilderDepthSideOptions`.

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

  Getter Method

  Signature `DepthSide`

  Returns: |
  Return type: | `NXOpen.Features.SheetMetal.NormalCutoutBuilderDepthSideOptions`

  New in version NX4.0.0.

  License requirements: nx_sheet_metal (“NX Sheet Metal”) OR nx_flexible_pcb (“NX Flexible PCB”)

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

  Setter Method

  Signature `DepthSide`

  Parameters: | depthSide (`NXOpen.Features.SheetMetal.NormalCutoutBuilderDepthSideOptions`) –

  New in version NX4.0.0.

  License requirements: nx_sheet_metal (“NX Sheet Metal”) OR nx_flexible_pcb (“NX Flexible PCB”)

## DepthType

`NormalCutoutBuilder.``DepthType`

  Returns or sets the depth type for the normal cutout.

  The options are in `NXOpen.Features.SheetMetal.NormalCutoutBuilderDepthTypeOptions`.

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

  Getter Method

  Signature `DepthType`

  Returns: |
  Return type: | `NXOpen.Features.SheetMetal.NormalCutoutBuilderDepthTypeOptions`

  New in version NX4.0.0.

  License requirements: nx_sheet_metal (“NX Sheet Metal”) OR nx_flexible_pcb (“NX Flexible PCB”)

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

  Setter Method

  Signature `DepthType`

  Parameters: | type (`NXOpen.Features.SheetMetal.NormalCutoutBuilderDepthTypeOptions`) –

  New in version NX4.0.0.

  License requirements: nx_sheet_metal (“NX Sheet Metal”) OR nx_flexible_pcb (“NX Flexible PCB”)

## From

`NormalCutoutBuilder.``From`

  Returns or sets the face or datum plane from which the cutout begins.

  This is only applicable if the depth type is `NXOpen.Features.SheetMetal.NormalCutoutBuilderDepthTypeOptions.FromTo`

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

  Getter Method

  Signature `From`

  Returns: | From face or datum plane
  Return type: | `NXOpen.ISurface`

  New in version NX4.0.0.

  License requirements: nx_sheet_metal (“NX Sheet Metal”) OR nx_flexible_pcb (“NX Flexible PCB”)

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

  Setter Method

  Signature `From`

  Parameters: | ffrom (`NXOpen.ISurface`) – From face or datum plane

  New in version NX4.0.0.

  License requirements: nx_sheet_metal (“NX Sheet Metal”) OR nx_flexible_pcb (“NX Flexible PCB”)

## Section

`NormalCutoutBuilder.``Section`

  Returns or sets the section used by the normal cutout.

  It can be open or closed.

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

  Getter Method

  Signature `Section`

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

  New in version NX4.0.0.

  License requirements: nx_sheet_metal (“NX Sheet Metal”) OR nx_flexible_pcb (“NX Flexible PCB”)

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

  Setter Method

  Signature `Section`

  Parameters: | section (`NXOpen.Section`) –

  New in version NX4.0.0.

  License requirements: nx_sheet_metal (“NX Sheet Metal”) OR nx_flexible_pcb (“NX Flexible PCB”)

## SectionSide

`NormalCutoutBuilder.``SectionSide`

  Returns or sets the side of the section that the normal cutout removes material.

  The options are in `NXOpen.Features.SheetMetal.NormalCutoutBuilderSectionSideOptions`.

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

  Getter Method

  Signature `SectionSide`

  Returns: |
  Return type: | `NXOpen.Features.SheetMetal.NormalCutoutBuilderSectionSideOptions`

  New in version NX4.0.0.

  License requirements: nx_sheet_metal (“NX Sheet Metal”) OR nx_flexible_pcb (“NX Flexible PCB”)

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

  Setter Method

  Signature `SectionSide`

  Parameters: | sectionSide (`NXOpen.Features.SheetMetal.NormalCutoutBuilderSectionSideOptions`) –

  New in version NX4.0.0.

  License requirements: nx_sheet_metal (“NX Sheet Metal”) OR nx_flexible_pcb (“NX Flexible PCB”)

## Sketch

`NormalCutoutBuilder.``Sketch`

  Returns or sets the internal sketch used by the normal cutout, if it exists.

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

  Getter Method

  Signature `Sketch`

  Returns: |
  Return type: | `NXOpen.Features.SketchFeature`

  New in version NX4.0.0.

  License requirements: nx_sheet_metal (“NX Sheet Metal”) OR nx_flexible_pcb (“NX Flexible PCB”)

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

  Setter Method

  Signature `Sketch`

  Parameters: | sketch (`NXOpen.Features.SketchFeature`) –

  New in version NX4.0.0.

  License requirements: nx_sheet_metal (“NX Sheet Metal”) OR nx_flexible_pcb (“NX Flexible PCB”)

## TargetBody

`NormalCutoutBuilder.``TargetBody`

  Returns or sets the target body on which the normal cutout is created.

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

  Getter Method

  Signature `TargetBody`

  Returns: | Returns the target body on which the normal cutout feature is created.
  Return type: | `NXOpen.Body`

  New in version NX10.0.0.

  License requirements: nx_sheet_metal (“NX Sheet Metal”) OR nx_flexible_pcb (“NX Flexible PCB”)

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

  Setter Method

  Signature `TargetBody`

  Parameters: | targetBody (`NXOpen.Body`) – A sheetmetal body on which normal cutout is to be created.

  New in version NX10.0.0.

  License requirements: nx_sheet_metal (“NX Sheet Metal”) OR nx_flexible_pcb (“NX Flexible PCB”)

## To

`NormalCutoutBuilder.``To`

  Returns or sets the face or datum plane at which the cutout ends.

  This is only applicable if the depth type is `NXOpen.Features.SheetMetal.NormalCutoutBuilderDepthTypeOptions.FromTo`

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

  Getter Method

  Signature `To`

  Returns: | To face or datum plane
  Return type: | `NXOpen.ISurface`

  New in version NX4.0.0.

  License requirements: nx_sheet_metal (“NX Sheet Metal”) OR nx_flexible_pcb (“NX Flexible PCB”)

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

  Setter Method

  Signature `To`

  Parameters: | to (`NXOpen.ISurface`) – To face or datum plane

  New in version NX4.0.0.

  License requirements: nx_sheet_metal (“NX Sheet Metal”) OR nx_flexible_pcb (“NX Flexible PCB”)

## Type

`NormalCutoutBuilder.``Type`

  Returns or sets the type for the normal cutout.

  The options are in `NXOpen.Features.SheetMetal.NormalCutoutBuilderTypeOptions`.

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

  Getter Method

  Signature `Type`

  Returns: |
  Return type: | `NXOpen.Features.SheetMetal.NormalCutoutBuilderTypeOptions`

  New in version NX6.0.0.

  License requirements: nx_sheet_metal (“NX Sheet Metal”) OR nx_flexible_pcb (“NX Flexible PCB”)

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

  Setter Method

  Signature `Type`

  Parameters: | type (`NXOpen.Features.SheetMetal.NormalCutoutBuilderTypeOptions`) –

  New in version NX6.0.0.

  License requirements: nx_sheet_metal (“NX Sheet Metal”) OR nx_flexible_pcb (“NX Flexible PCB”)

# Method Detail

## SetDepth

`NormalCutoutBuilder.``SetDepth`

  Signature `SetDepth(depth)`

  Parameters: | depth (str) –

  New in version NX4.0.0.

  Deprecated since version NX10.0.0: Use `NXOpen.Expression.RightHandSide()` on the `NXOpen.Expression` object returned from `NXOpen.Features.SheetMetal.NormalCutoutBuilder.Depth()` instead.

  License requirements: nx_sheet_metal (“NX Sheet Metal”) OR nx_flexible_pcb (“NX Flexible PCB”)

## Validate

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

## ValidateBuilderData

`NormalCutoutBuilder.``ValidateBuilderData`

  Verify that the builder data is valid for creating a normal cutout.

  If the builder data is valid, a value of 0 is returned.

  Signature `ValidateBuilderData()`

  Returns: | data validity flag (zero is valid, non-zero is invalid).
  Return type: | int

  New in version NX4.0.0.

  License requirements: nx_sheet_metal (“NX Sheet Metal”) OR nx_flexible_pcb (“NX Flexible PCB”)