StockPartConverterBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# StockPartConverterBuilder Class

class `NXOpen.Routing.``StockPartConverterBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.Routing.StockPartConverterBuilder` Builder for Part Conversion of the stocks.

  This also provides an option to Recreate stock components during part conversion. To create a new instance of this class, use `NXOpen.Routing.RouteManager.CreateStockPartConverterBuilder()`

  Default values.

  Property | Value
  --- | ---
  RecreateStockComponentsOption | 0

  New in version NX10.0.0.

# Properties

Property | Description
--- | ---
ConvertWorkPartAndLoadedChildrenOption | Returns or sets the convert workpart and loaded children option.
RecreateStockComponentsOption | Returns or sets the recreate StockComponents option.
Tag | Returns the Tag for this object.

# 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.
GetObject | Returns the object currently being edited by this builder.
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

StockPartConverterBuilderPartOption Enumeration | Represents the option to indicate the scope of stock part coversion

# Property Detail

## ConvertWorkPartAndLoadedChildrenOption

`StockPartConverterBuilder.``ConvertWorkPartAndLoadedChildrenOption`

  Returns or sets the convert workpart and loaded children option.

  Returns if the stocks from only the work part or from the work part and loaded children have to be converted during part conversion.

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

  Getter Method

  Signature `ConvertWorkPartAndLoadedChildrenOption`

  Returns: |
  Return type: | `NXOpen.Routing.StockPartConverterBuilderPartOption`

  New in version NX10.0.0.

  License requirements: routing_base (“Routing Basic”)

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

  Setter Method

  Signature `ConvertWorkPartAndLoadedChildrenOption`

  Parameters: | conversionOption (`NXOpen.Routing.StockPartConverterBuilderPartOption`) –

  New in version NX10.0.0.

  License requirements: routing_base (“Routing Basic”)

## RecreateStockComponentsOption

`StockPartConverterBuilder.``RecreateStockComponentsOption`

  Returns or sets the recreate StockComponents option.

  Returns true if the stock components have to be recreated during part conversion.

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

  Getter Method

  Signature `RecreateStockComponentsOption`

  Returns: |
  Return type: | bool

  New in version NX10.0.0.

  License requirements: routing_base (“Routing Basic”)

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

  Setter Method

  Signature `RecreateStockComponentsOption`

  Parameters: | recreateStockComponentsOption (bool) –

  New in version NX10.0.0.

  License requirements: routing_base (“Routing Basic”)

# Method Detail

## Validate

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