DPMItpBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# DPMItpBuilder Class

class `NXOpen.CAM.``DPMItpBuilder`

  Bases: `NXOpen.CAM.ParamBuilder`

  Represents an DPMItp Builder

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

  New in version NX5.0.0.

# Properties

Property | Description
--- | ---
CrossCurveCount | Returns or sets the cross curve count
CrossCurveList | Returns the Cross Curve List
CrossCurveNormalToFlowCount | Returns or sets the cross curves normal to flow count
CrossCurvesMethod | Returns or sets the cross curves selection method
CutPatternBuilder | Returns the cut pattern builder
CutStepBuilder | Returns the cut step builder
CutStepFirstCut | Returns or sets the First Cut
CutStepSecondCut | Returns or sets the Second Cut
CutStepThirdCut | Returns or sets the Third Cut
CutType | Returns or sets the cut type
CycleEvent | Returns the cycle event
CycleTable | Returns the cycle
FlowCurveCount | Returns or sets the flow curve count
FlowCurveList | Returns the Flow Curve List
OptimizationMethod | Returns or sets the optim method
PreviewEnabled | Returns or sets the use of preview
SelectionMethod | Returns or sets the flow and cross selection method
StepIntol | Returns the Cut Step Intol
StepMethod | Returns or sets the Cut Step
StepOuttol | Returns the Cut Step Outol
StepoverBuilder | Returns the stepover builder
StepoverDis | Returns or sets the stepover distance
StepoverNum | Returns or sets the stepover number
StepoverScallopHeight | Returns or sets the stepover scallop height
StepoverType | Returns or sets the stepover type
Tag | Returns the Tag for this object.
ToolPosition | Returns or sets the tool position
ToolPositionBuilder | Returns the tool position builder
TrimExtendBuilder | Returns the trim and extend builder
UsePartNormal | Returns or sets the use of part normal

# 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.
GetCrossCurveNormalToFlowCurve | Returns the flow curve used in generation of cross curve normal to flow.
GetCustomizableItemBuilder | Returns the customizable item builder for the given customizable item name
GetCustomizableItemNames | Returns the names for all customizable item ids
GetExtendValues | Get the extend values
GetObject | Returns the object currently being edited by this builder.
MPreview | Preview drive path
SetCrossCurveNormalToFlowCurve | Sets the flow curve used in generation of cross curves normal to flow.
SetExtendValues | Set the extend values
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

DPMItpBuilderCrossCurvesMethodOption Enumeration | Enum of cross curves creation method
DPMItpBuilderCutTypeOption Enumeration | Enum of cut type
DPMItpBuilderSelectionMethodOption Enumeration | Enum of selection method
DPMItpBuilderStepMethodOption Enumeration | Enum of step method
DPMItpBuilderStepoverTypeOption Enumeration | Enum of stepover type
DPMItpBuilderToolPositionOption Enumeration | Enum of tool position

# Property Detail

## CrossCurveCount

`DPMItpBuilder.``CrossCurveCount`

  Returns or sets the cross curve count

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

  Getter Method

  Signature `CrossCurveCount`

  Returns: | the cross curve count
  Return type: | int

  New in version NX9.0.3.

  License requirements: cam_base (“CAM BASE”)

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

  Setter Method

  Signature `CrossCurveCount`

  Parameters: | crossCurveCount (int) – the cross curve count

  New in version NX9.0.3.

  License requirements: cam_base (“CAM BASE”)

## CrossCurveList

`DPMItpBuilder.``CrossCurveList`

  Returns the Cross Curve List

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

  Getter Method

  Signature `CrossCurveList`

  Returns: | the cross curve list
  Return type: | `NXOpen.SectionList`

  New in version NX6.0.0.

  License requirements: None.

## CrossCurveNormalToFlowCount

`DPMItpBuilder.``CrossCurveNormalToFlowCount`

  Returns or sets the cross curves normal to flow count

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

  Getter Method

  Signature `CrossCurveNormalToFlowCount`

  Returns: | the cross curve normal to flow count
  Return type: | int

  New in version NX10.0.3.

  License requirements: cam_base (“CAM BASE”)

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

  Setter Method

  Signature `CrossCurveNormalToFlowCount`

  Parameters: | crossCurveNormalToFlowCount (int) – the cross curve normal to flow count

  New in version NX10.0.3.

  License requirements: cam_base (“CAM BASE”)

## CrossCurvesMethod

`DPMItpBuilder.``CrossCurvesMethod`

  Returns or sets the cross curves selection method

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

  Getter Method

  Signature `CrossCurvesMethod`

  Returns: | the cross curves method value
  Return type: | `NXOpen.CAM.DPMItpBuilderCrossCurvesMethodOption`

  New in version NX10.0.3.

  License requirements: cam_base (“CAM BASE”)

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

  Setter Method

  Signature `CrossCurvesMethod`

  Parameters: | crossCurvesMethod (`NXOpen.CAM.DPMItpBuilderCrossCurvesMethodOption`) – the cross curves method value

  New in version NX10.0.3.

  License requirements: cam_base (“CAM BASE”)

## CutPatternBuilder

`DPMItpBuilder.``CutPatternBuilder`

  Returns the cut pattern builder

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

  Getter Method

  Signature `CutPatternBuilder`

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

  New in version NX6.0.0.

  License requirements: None.

## CutStepBuilder

`DPMItpBuilder.``CutStepBuilder`

  Returns the cut step builder

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

  Getter Method

  Signature `CutStepBuilder`

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

  New in version NX10.0.1.

  License requirements: None.

## CutStepFirstCut

`DPMItpBuilder.``CutStepFirstCut`

  Returns or sets the First Cut

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

  Getter Method

  Signature `CutStepFirstCut`

  Returns: | the first cut value
  Return type: | int

  New in version NX7.5.0.

  Deprecated since version NX10.0.1: Use `NXOpen.CAM.DmStreamlineCutStep.FirstCut`()` instead.

  License requirements: None.

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

  Setter Method

  Signature `CutStepFirstCut`

  Parameters: | firstCut (int) – the first cut value

  New in version NX7.5.0.

  Deprecated since version NX10.0.1: Use `NXOpen.CAM.DmStreamlineCutStep.FirstCut`()` instead.

  License requirements: None.

## CutStepSecondCut

`DPMItpBuilder.``CutStepSecondCut`

  Returns or sets the Second Cut

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

  Getter Method

  Signature `CutStepSecondCut`

  Returns: | the second cut value
  Return type: | int

  New in version NX7.5.0.

  Deprecated since version NX10.0.1: Use `NXOpen.CAM.DmStreamlineCutStep.SecondCut`()` instead.

  License requirements: None.

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

  Setter Method

  Signature `CutStepSecondCut`

  Parameters: | secondCut (int) – the second cut value

  New in version NX7.5.0.

  Deprecated since version NX10.0.1: Use `NXOpen.CAM.DmStreamlineCutStep.SecondCut`()` instead.

  License requirements: None.

## CutStepThirdCut

`DPMItpBuilder.``CutStepThirdCut`

  Returns or sets the Third Cut

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

  Getter Method

  Signature `CutStepThirdCut`

  Returns: | the third cut value
  Return type: | int

  New in version NX7.5.0.

  Deprecated since version NX10.0.1: Use `NXOpen.CAM.DmStreamlineCutStep.ThirdCut`()` instead.

  License requirements: None.

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

  Setter Method

  Signature `CutStepThirdCut`

  Parameters: | thirdCut (int) – the third cut value

  New in version NX7.5.0.

  Deprecated since version NX10.0.1: Use `NXOpen.CAM.DmStreamlineCutStep.ThirdCut`()` instead.

  License requirements: None.

## CutType

`DPMItpBuilder.``CutType`

  Returns or sets the cut type

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

  Getter Method

  Signature `CutType`

  Returns: | the cut type value
  Return type: | `NXOpen.CAM.DPMItpBuilderCutTypeOption`

  New in version NX5.0.0.

  License requirements: cam_base (“CAM BASE”)

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

  Setter Method

  Signature `CutType`

  Parameters: | cutType (`NXOpen.CAM.DPMItpBuilderCutTypeOption`) – the cut type value

  New in version NX5.0.0.

  License requirements: cam_base (“CAM BASE”)

## FlowCurveCount

`DPMItpBuilder.``FlowCurveCount`

  Returns or sets the flow curve count

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

  Getter Method

  Signature `FlowCurveCount`

  Returns: | the flow curve count
  Return type: | int

  New in version NX9.0.3.

  License requirements: cam_base (“CAM BASE”)

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

  Setter Method

  Signature `FlowCurveCount`

  Parameters: | flowCurveCount (int) – the flow curve count

  New in version NX9.0.3.

  License requirements: cam_base (“CAM BASE”)

## FlowCurveList

`DPMItpBuilder.``FlowCurveList`

  Returns the Flow Curve List

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

  Getter Method

  Signature `FlowCurveList`

  Returns: | the flow curve list
  Return type: | `NXOpen.SectionList`

  New in version NX6.0.0.

  License requirements: None.

## PreviewEnabled

`DPMItpBuilder.``PreviewEnabled`

  Returns or sets the use of preview

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

  Getter Method

  Signature `PreviewEnabled`

  Returns: | the use of preview enabled
  Return type: | bool

  New in version NX10.0.3.

  License requirements: cam_base (“CAM BASE”)

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

  Setter Method

  Signature `PreviewEnabled`

  Parameters: | previewEnabled (bool) – the use of preview enabled

  New in version NX10.0.3.

  License requirements: cam_base (“CAM BASE”)

## SelectionMethod

`DPMItpBuilder.``SelectionMethod`

  Returns or sets the flow and cross selection method

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

  Getter Method

  Signature `SelectionMethod`

  Returns: | the selection method value
  Return type: | `NXOpen.CAM.DPMItpBuilderSelectionMethodOption`

  New in version NX5.0.0.

  License requirements: cam_base (“CAM BASE”)

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

  Setter Method

  Signature `SelectionMethod`

  Parameters: | selectionMethod (`NXOpen.CAM.DPMItpBuilderSelectionMethodOption`) – the selection method value

  New in version NX5.0.0.

  License requirements: cam_base (“CAM BASE”)

## StepIntol

`DPMItpBuilder.``StepIntol`

  Returns the Cut Step Intol

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

  Getter Method

  Signature `StepIntol`

  Returns: | The Step Intol
  Return type: | `NXOpen.CAM.InheritableDoubleBuilder`

  New in version NX7.5.0.

  Deprecated since version NX10.0.1: Use `NXOpen.CAM.DmStreamlineCutStep.StepIntol()` instead.

  License requirements: None.

## StepMethod

`DPMItpBuilder.``StepMethod`

  Returns or sets the Cut Step

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

  Getter Method

  Signature `StepMethod`

  Returns: | the value of Cut Step
  Return type: | `NXOpen.CAM.DPMItpBuilderStepMethodOption`

  New in version NX7.5.0.

  Deprecated since version NX10.0.1: Use `NXOpen.CAM.DmStreamlineCutStep.CutStepType`()` instead.

  License requirements: None.

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

  Setter Method

  Signature `StepMethod`

  Parameters: | stepMethod (`NXOpen.CAM.DPMItpBuilderStepMethodOption`) – the value of Cut Step

  New in version NX7.5.0.

  Deprecated since version NX10.0.1: Use `NXOpen.CAM.DmStreamlineCutStep.CutStepType`()` instead.

  License requirements: None.

## StepOuttol

`DPMItpBuilder.``StepOuttol`

  Returns the Cut Step Outol

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

  Getter Method

  Signature `StepOuttol`

  Returns: | The Step Outol
  Return type: | `NXOpen.CAM.InheritableDoubleBuilder`

  New in version NX7.5.0.

  Deprecated since version NX10.0.1: Use `NXOpen.CAM.DmStreamlineCutStep.StepOutol()` instead.

  License requirements: None.

## StepoverBuilder

`DPMItpBuilder.``StepoverBuilder`

  Returns the stepover builder

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

  Getter Method

  Signature `StepoverBuilder`

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

  New in version NX6.0.0.

  License requirements: None.

## StepoverDis

`DPMItpBuilder.``StepoverDis`

  Returns or sets the stepover distance

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

  Getter Method

  Signature `StepoverDis`

  Returns: | the stepover distance value
  Return type: | float

  New in version NX5.0.0.

  License requirements: cam_base (“CAM BASE”)

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

  Setter Method

  Signature `StepoverDis`

  Parameters: | stepoverDis (float) – the stepover distance value

  New in version NX5.0.0.

  License requirements: cam_base (“CAM BASE”)

## StepoverNum

`DPMItpBuilder.``StepoverNum`

  Returns or sets the stepover number

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

  Getter Method

  Signature `StepoverNum`

  Returns: | the stepover number value
  Return type: | int

  New in version NX5.0.0.

  License requirements: cam_base (“CAM BASE”)

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

  Setter Method

  Signature `StepoverNum`

  Parameters: | stepoverNum (int) – the stepover number value

  New in version NX5.0.0.

  License requirements: cam_base (“CAM BASE”)

## StepoverScallopHeight

`DPMItpBuilder.``StepoverScallopHeight`

  Returns or sets the stepover scallop height

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

  Getter Method

  Signature `StepoverScallopHeight`

  Returns: | the stepover scallop height value
  Return type: | float

  New in version NX5.0.0.

  License requirements: cam_base (“CAM BASE”)

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

  Setter Method

  Signature `StepoverScallopHeight`

  Parameters: | stepoverScallopHeight (float) – the stepover scallop height value

  New in version NX5.0.0.

  License requirements: cam_base (“CAM BASE”)

## StepoverType

`DPMItpBuilder.``StepoverType`

  Returns or sets the stepover type

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

  Getter Method

  Signature `StepoverType`

  Returns: | the stepover type value
  Return type: | `NXOpen.CAM.DPMItpBuilderStepoverTypeOption`

  New in version NX5.0.0.

  License requirements: cam_base (“CAM BASE”)

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

  Setter Method

  Signature `StepoverType`

  Parameters: | stepoverType (`NXOpen.CAM.DPMItpBuilderStepoverTypeOption`) – the stepover type value

  New in version NX5.0.0.

  License requirements: cam_base (“CAM BASE”)

## ToolPosition

`DPMItpBuilder.``ToolPosition`

  Returns or sets the tool position

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

  Getter Method

  Signature `ToolPosition`

  Returns: | the tool position value
  Return type: | `NXOpen.CAM.DPMItpBuilderToolPositionOption`

  New in version NX5.0.0.

  Deprecated since version NX10.0.1: Use `NXOpen.CAM.DmToolPosition.ToolPosition`()` instead.

  License requirements: cam_base (“CAM BASE”)

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

  Setter Method

  Signature `ToolPosition`

  Parameters: | toolPosition (`NXOpen.CAM.DPMItpBuilderToolPositionOption`) – the tool position value

  New in version NX5.0.0.

  Deprecated since version NX10.0.1: Use `NXOpen.CAM.DmToolPosition.ToolPosition`()` instead.

  License requirements: cam_base (“CAM BASE”)

## ToolPositionBuilder

`DPMItpBuilder.``ToolPositionBuilder`

  Returns the tool position builder

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

  Getter Method

  Signature `ToolPositionBuilder`

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

  New in version NX10.0.1.

  License requirements: None.

## TrimExtendBuilder

`DPMItpBuilder.``TrimExtendBuilder`

  Returns the trim and extend builder

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

  Getter Method

  Signature `TrimExtendBuilder`

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

  New in version NX10.0.1.

  License requirements: None.

## UsePartNormal

`DPMItpBuilder.``UsePartNormal`

  Returns or sets the use of part normal

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

  Getter Method

  Signature `UsePartNormal`

  Returns: | the use of part normal
  Return type: | bool

  New in version NX10.0.2.

  License requirements: cam_base (“CAM BASE”)

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

  Setter Method

  Signature `UsePartNormal`

  Parameters: | usePartNormal (bool) – the use of part normal

  New in version NX10.0.2.

  License requirements: cam_base (“CAM BASE”)

# Method Detail

## GetCrossCurveNormalToFlowCurve

`DPMItpBuilder.``GetCrossCurveNormalToFlowCurve`

  Returns the flow curve used in generation of cross curve normal to flow.

  Signature `GetCrossCurveNormalToFlowCurve()`

  Returns: | Array of curves
  Return type: | list of `NXOpen.TaggedObject`

  New in version NX10.0.3.

  License requirements: cam_base (“CAM BASE”)

## GetExtendValues

`DPMItpBuilder.``GetExtendValues`

  Get the extend values

  Signature `GetExtendValues()`

  Returns: | the extend values
  Return type: | list of float

  New in version NX5.0.0.

  Deprecated since version NX10.0.1: Use `NXOpen.CAM.DmTrimExtend` instead.

  License requirements: cam_base (“CAM BASE”)

## MPreview

`DPMItpBuilder.``MPreview`

  Preview drive path

  Signature `MPreview()`

  New in version NX5.0.0.

  License requirements: cam_base (“CAM BASE”)

## SetCrossCurveNormalToFlowCurve

`DPMItpBuilder.``SetCrossCurveNormalToFlowCurve`

  Sets the flow curve used in generation of cross curves normal to flow.

  Signature `SetCrossCurveNormalToFlowCurve(curves)`

  Parameters: | curves (list of `NXOpen.TaggedObject`) – Array of curves

  New in version NX10.0.3.

  License requirements: cam_base (“CAM BASE”)

## SetExtendValues

`DPMItpBuilder.``SetExtendValues`

  Set the extend values

  Signature `SetExtendValues(values)`

  Parameters: | values (list of float) – the extend value

  New in version NX5.0.0.

  Deprecated since version NX10.0.1: Use `NXOpen.CAM.DmTrimExtend` instead.

  License requirements: cam_base (“CAM BASE”)

## Validate

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