MethodBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# MethodBuilder Class

class `NXOpen.CAM.``MethodBuilder`

  Bases: `NXOpen.CAM.NCGroupBuilder`

  Represents a Method Builder

  This is an abstract class, and cannot be instantiated.

  New in version NX5.0.0.

# Properties

Property | Description
--- | ---
CutParameters | Returns the cut parameter object
CycleEvent | Returns the cycle event
CycleTable | Returns the cycle
Description | Returns or sets the description
EndUdeSet | Returns the end ude set
OptimizationMethod | Returns or sets the optim method
PaintDisplay | Returns the sub builder for paint display
PathDisplay | Returns the sub builder for path display
PathDisplayColors | Returns the sub builder for path display colors
SilhouDisplay | Returns the sub builder for silhou display
StartUdeSet | Returns the start ude set
Tag | Returns the Tag for this object.
ToolDisplay | Returns the sub builder for tool display

# 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
GetCutMethod | Get cut method
GetObject | Returns the object currently being edited by this builder.
SetCutMethod | Set cut method
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

## CutParameters

`MethodBuilder.``CutParameters`

  Returns the cut parameter object

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

  Getter Method

  Signature `CutParameters`

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

  New in version NX6.0.0.

  License requirements: cam_base (“CAM BASE”)

## PaintDisplay

`MethodBuilder.``PaintDisplay`

  Returns the sub builder for paint display

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

  Getter Method

  Signature `PaintDisplay`

  Returns: | the paint_display
  Return type: | `NXOpen.CAM.DisplayPaint`

  New in version NX7.5.0.

  License requirements: None.

## PathDisplay

`MethodBuilder.``PathDisplay`

  Returns the sub builder for path display

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

  Getter Method

  Signature `PathDisplay`

  Returns: | the path_display
  Return type: | `NXOpen.CAM.DisplayPath`

  New in version NX7.5.0.

  License requirements: None.

## PathDisplayColors

`MethodBuilder.``PathDisplayColors`

  Returns the sub builder for path display colors

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

  Getter Method

  Signature `PathDisplayColors`

  Returns: | the path_display_colors
  Return type: | `NXOpen.CAM.PathDisplayColors`

  New in version NX7.5.0.

  License requirements: None.

## SilhouDisplay

`MethodBuilder.``SilhouDisplay`

  Returns the sub builder for silhou display

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

  Getter Method

  Signature `SilhouDisplay`

  Returns: | the silhou_display
  Return type: | `NXOpen.CAM.DisplaySilhouette`

  New in version NX7.5.0.

  License requirements: None.

## ToolDisplay

`MethodBuilder.``ToolDisplay`

  Returns the sub builder for tool display

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

  Getter Method

  Signature `ToolDisplay`

  Returns: | the tool_display
  Return type: | `NXOpen.CAM.DisplayTool`

  New in version NX7.5.0.

  License requirements: None.

# Method Detail

## GetCutMethod

`MethodBuilder.``GetCutMethod`

  Get cut method

  Signature `GetCutMethod()`

  Returns: |
  Return type: | str

  New in version NX8.0.1.

  License requirements: None.

## SetCutMethod

`MethodBuilder.``SetCutMethod`

  Set cut method

  Signature `SetCutMethod(libRef)`

  Parameters: | libRef (str) –

  New in version NX8.0.1.

  License requirements: cam_base (“CAM BASE”)

## Validate

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