PierceTaskBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# PierceTaskBuilder Class

class `NXOpen.Die.``PierceTaskBuilder`

  Bases: `NXOpen.Features.FeatureBuilder`

  Represents a Pierce Task feature builder

  To create a new instance of this class, use `NXOpen.Die.DieCollection.PierceTask()`

  New in version NX4.0.0.

# Properties

Property | Description
--- | ---
AngleTolerance | Returns or sets the angle tolerance of the pierce task
AssociatedObjects | Returns the assoc objects
CamDirection | Returns or sets the cam direction of the pierce task
CamType | Returns or sets the cam type of the pierce task
CenterPointOption | Returns or sets the center point output option of the pierce task
CreateScrap | Returns or sets the create scrap setting of the pierce task.
DistanceTolerance | Returns or sets the distance tolerance of the pierce task
FinishOperation | Returns or sets the finish operation of the pierce task True indicates the pierce is to be a finish pierce.
LayoutFlange | Returns or sets the layout flange setting of the pierce task.
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
PierceHoles | Returns the pierce holes
PierceHolesList | Returns the pierce holes list
PrecisionType | Returns or sets the precision type of the pierce task
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename
Tag | Returns the Tag for this object.
TipFeature | Returns the tip feature
TippedProduct | Returns or sets the tipped product of the pierce task
TrimNewDieFace | Returns or sets the trim new die face, from NX10.
WithoutWorkflowSheet | Returns or sets the without workflow sheet of the pierce task builder.

# 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.
GetAssociativeObjects | Gets the associative objects of the pierce task
GetCameraLayerAndXmlp | Gets the camera layer settings and xmlp data
GetCameraNames | Gets the names of the camera
GetCameraViews | Gets the camera views of the pierce task
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit.
GetDetails | Gets the detailed description of the pierce task
GetFeature | Returns the feature currently being edited by this builder.
GetObject | Returns the object currently being edited by this builder.
GetPierceBounds | Gets the pierce bounds of the pierce task
HideInternalParentFeatureAfterEdit | Re-suppress an internal parent feature (a slave feature) after it has been edited.
NewPierceHole | Creates a new pierce hole item in the set
SetAssociativeObjects | Sets the associative objects of the pierce task
SetCameraLayerAndXmlp | Sets the camera layer settings and xmlp data
SetCameraNames | Sets the names of the camera
SetCameraViews | Sets the camera views of the pierce task
SetDetails | Sets the detailed description of the pierce task
SetParentFeatureInternal | Set the parent features which would be internal or slaves to the feature being created or commited
SetPierceBounds | Sets the pierce bounds of the pierce task.
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.

# Enumerations

PierceTaskBuilderCamTypes Enumeration | Settings for the cam type of the pierce task.
PierceTaskBuilderCenterPointOptionTypes Enumeration | Settings for the center point output options of the pierce task.
PierceTaskBuilderPrecisionTypes Enumeration | Settings for the precistion type of the pierce task.

# Property Detail

## AngleTolerance

`PierceTaskBuilder.``AngleTolerance`

  Returns or sets the angle tolerance of the pierce task

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

  Getter Method

  Signature `AngleTolerance`

  Returns: |
  Return type: | float

  New in version NX4.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

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

  Setter Method

  Signature `AngleTolerance`

  Parameters: | angleTolerance (float) –

  New in version NX4.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

## AssociatedObjects

`PierceTaskBuilder.``AssociatedObjects`

  Returns the assoc objects

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

  Getter Method

  Signature `AssociatedObjects`

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

  New in version NX5.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

## CamDirection

`PierceTaskBuilder.``CamDirection`

  Returns or sets the cam direction of the pierce task

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

  Getter Method

  Signature `CamDirection`

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

  New in version NX4.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

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

  Setter Method

  Signature `CamDirection`

  Parameters: | camDirection (`NXOpen.ILocation`) –

  New in version NX4.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

## CamType

`PierceTaskBuilder.``CamType`

  Returns or sets the cam type of the pierce task

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

  Getter Method

  Signature `CamType`

  Returns: |
  Return type: | `NXOpen.Die.PierceTaskBuilderCamTypes`

  New in version NX4.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

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

  Setter Method

  Signature `CamType`

  Parameters: | camType (`NXOpen.Die.PierceTaskBuilderCamTypes`) –

  New in version NX4.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

## CenterPointOption

`PierceTaskBuilder.``CenterPointOption`

  Returns or sets the center point output option of the pierce task

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

  Getter Method

  Signature `CenterPointOption`

  Returns: |
  Return type: | `NXOpen.Die.PierceTaskBuilderCenterPointOptionTypes`

  New in version NX5.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

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

  Setter Method

  Signature `CenterPointOption`

  Parameters: | centerPointOption (`NXOpen.Die.PierceTaskBuilderCenterPointOptionTypes`) –

  New in version NX5.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

## CreateScrap

`PierceTaskBuilder.``CreateScrap`

  Returns or sets the create scrap setting of the pierce task.

  True indicates that the scrap is to be created.

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

  Getter Method

  Signature `CreateScrap`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

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

  Setter Method

  Signature `CreateScrap`

  Parameters: | createScrap (bool) –

  New in version NX7.5.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

## DistanceTolerance

`PierceTaskBuilder.``DistanceTolerance`

  Returns or sets the distance tolerance of the pierce task

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

  Getter Method

  Signature `DistanceTolerance`

  Returns: |
  Return type: | float

  New in version NX4.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

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

  Setter Method

  Signature `DistanceTolerance`

  Parameters: | distanceTolerance (float) –

  New in version NX4.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

## FinishOperation

`PierceTaskBuilder.``FinishOperation`

  Returns or sets the finish operation of the pierce task True indicates the pierce is to be a finish pierce.

  False indicates rough pierce.

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

  Getter Method

  Signature `FinishOperation`

  Returns: |
  Return type: | bool

  New in version NX4.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

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

  Setter Method

  Signature `FinishOperation`

  Parameters: | finishOperation (bool) –

  New in version NX4.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

## LayoutFlange

`PierceTaskBuilder.``LayoutFlange`

  Returns or sets the layout flange setting of the pierce task.

  True indicates that the pierce curve is to be laid out on the flange.

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

  Getter Method

  Signature `LayoutFlange`

  Returns: |
  Return type: | bool

  New in version NX4.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

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

  Setter Method

  Signature `LayoutFlange`

  Parameters: | layoutFlange (bool) –

  New in version NX4.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

## PierceHoles

`PierceTaskBuilder.``PierceHoles`

  Returns the pierce holes

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

  Getter Method

  Signature `PierceHoles`

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

  New in version NX5.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

## PierceHolesList

`PierceTaskBuilder.``PierceHolesList`

  Returns the pierce holes list

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

  Getter Method

  Signature `PierceHolesList`

  Returns: |
  Return type: | `NXOpen.Die.PierceItemBuilderList`

  New in version NX5.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

## PrecisionType

`PierceTaskBuilder.``PrecisionType`

  Returns or sets the precision type of the pierce task

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

  Getter Method

  Signature `PrecisionType`

  Returns: |
  Return type: | `NXOpen.Die.PierceTaskBuilderPrecisionTypes`

  New in version NX4.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

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

  Setter Method

  Signature `PrecisionType`

  Parameters: | precisionType (`NXOpen.Die.PierceTaskBuilderPrecisionTypes`) –

  New in version NX4.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

## TipFeature

`PierceTaskBuilder.``TipFeature`

  Returns the tip feature

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

  Getter Method

  Signature `TipFeature`

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

  New in version NX5.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

## TippedProduct

`PierceTaskBuilder.``TippedProduct`

  Returns or sets the tipped product of the pierce task

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

  Getter Method

  Signature `TippedProduct`

  Returns: | The tip of the operation where the pierce

  task resides. :rtype: `NXOpen.Features.Feature`

  New in version NX4.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

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

  Setter Method

  Signature `TippedProduct`

  Parameters: | tippedProduct (`NXOpen.Features.Feature`) – The tip of the operation where the pierce task resides.

  New in version NX4.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

## TrimNewDieFace

`PierceTaskBuilder.``TrimNewDieFace`

  Returns or sets the trim new die face, from NX10.

  0 new stamping output can import one new die face to die engineer process. If this pierce task will trim this new die face, set trimNewDieFace to true, or else set it to false.

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

  Getter Method

  Signature `TrimNewDieFace`

  Returns: | if pierce task performs on new die face, this will be true, or else this will be false.
  Return type: | bool

  New in version NX10.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

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

  Setter Method

  Signature `TrimNewDieFace`

  Parameters: | trimNewDieFace (bool) – if set to true, pierce task performs on new die face, or else it will perform on original die face.

  New in version NX10.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

## WithoutWorkflowSheet

`PierceTaskBuilder.``WithoutWorkflowSheet`

  Returns or sets the without workflow sheet of the pierce task builder.

  In release NX11.0, pierce task supports without workflow type when the workflow tip feature does not exist.

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

  Getter Method

  Signature `WithoutWorkflowSheet`

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

  New in version NX11.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

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

  Setter Method

  Signature `WithoutWorkflowSheet`

  Parameters: | sheet (`NXOpen.Body`) –

  New in version NX11.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

# Method Detail

## GetAssociativeObjects

`PierceTaskBuilder.``GetAssociativeObjects`

  Gets the associative objects of the pierce task

  Signature `GetAssociativeObjects()`

  Returns: |
  Return type: | list of `NXOpen.DisplayableObject`

  New in version NX4.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

## GetCameraLayerAndXmlp

`PierceTaskBuilder.``GetCameraLayerAndXmlp`

  Gets the camera layer settings and xmlp data

  Signature `GetCameraLayerAndXmlp()`

  Returns: | a tuple
  Return type: | A tuple consisting of (layerSettings, xmlpData) layerSettings is a list of str. 1 layer setting string for each camera object. the string needs to be 256 characters long (one for each user layer) with either 0 for off or 1 for on. xmlpData is a list of str. xmlp data

  New in version NX4.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

## GetCameraNames

`PierceTaskBuilder.``GetCameraNames`

  Gets the names of the camera

  Signature `GetCameraNames()`

  Returns: | each string contains the name of a camera object
  Return type: | list of str

  New in version NX4.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

## GetCameraViews

`PierceTaskBuilder.``GetCameraViews`

  Gets the camera views of the pierce task

  Signature `GetCameraViews()`

  Returns: |
  Return type: | list of `NXOpen.View`

  New in version NX4.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

## GetDetails

`PierceTaskBuilder.``GetDetails`

  Gets the detailed description of the pierce task

  Signature `GetDetails()`

  Returns: | detail strings
  Return type: | list of str

  New in version NX4.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

## GetPierceBounds

`PierceTaskBuilder.``GetPierceBounds`

  Gets the pierce bounds of the pierce task

  Signature `GetPierceBounds()`

  Returns: | a tuple
  Return type: | A tuple consisting of (profileEntries, direction). profileEntries is a list of `NXOpen.IProfile`. Profile entries that make up the boundary of the pierce task direction is a `NXOpen.Die.DirectionOption`. Profile direction

  New in version NX4.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

## NewPierceHole

`PierceTaskBuilder.``NewPierceHole`

  Creates a new pierce hole item in the set

  Signature `NewPierceHole(holeShape)`

  Parameters: | holeShape (`NXOpen.Die.PierceItemBuilderHoleShapeType`) –
  Returns: |
  Return type: | `NXOpen.Die.PierceItemBuilder`

  New in version NX5.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

## SetAssociativeObjects

`PierceTaskBuilder.``SetAssociativeObjects`

  Sets the associative objects of the pierce task

  Signature `SetAssociativeObjects(objects)`

  Parameters: | objects (list of `NXOpen.DisplayableObject`) –

  New in version NX4.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

## SetCameraLayerAndXmlp

`PierceTaskBuilder.``SetCameraLayerAndXmlp`

  Sets the camera layer settings and xmlp data

  Signature `SetCameraLayerAndXmlp(layerSettings, xmlpData)`

  Parameters:

  - layerSettings (list of str) – 1 layer setting string for each camera object. the string needs to be 256 characters long (one for each user layer) with either 0 for off or 1 for on.
  - xmlpData (list of str) – xmlp data

  New in version NX4.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

## SetCameraNames

`PierceTaskBuilder.``SetCameraNames`

  Sets the names of the camera

  Signature `SetCameraNames(strings)`

  Parameters: | strings (list of str) – each string contains the name of a camera object

  New in version NX4.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

## SetCameraViews

`PierceTaskBuilder.``SetCameraViews`

  Sets the camera views of the pierce task

  Signature `SetCameraViews(objects)`

  Parameters: | objects (list of `NXOpen.View`) –

  New in version NX4.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

## SetDetails

`PierceTaskBuilder.``SetDetails`

  Sets the detailed description of the pierce task

  Signature `SetDetails(strings)`

  Parameters: | strings (list of str) – detail strings

  New in version NX4.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

## SetPierceBounds

`PierceTaskBuilder.``SetPierceBounds`

  Sets the pierce bounds of the pierce task.

  Note - `Die.PierceTaskBuilder.TippedProduct()` needs to be called before this function.

  Signature `SetPierceBounds(direction, profileEntries)`

  Parameters:

  - direction (`NXOpen.Die.DirectionOption`) – Profile direction
  - profileEntries (list of `NXOpen.IProfile`) – Profile entries that make up the boundary of the pierce task

  New in version NX4.0.0.

  License requirements: die_engineering (“DIE ENGINEERING”)

## Validate

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