MergeStocksBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# MergeStocksBuilder Class

class `NXOpen.Routing.``MergeStocksBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.Routing.MergeStocksBuilder` Builder for merging routing stocks ( including space reservation stocks ).

  To create a new instance of this class, use `NXOpen.Routing.RouteManager.CreateMergeStocksBuilder()`

  New in version NX10.0.0.

# Properties

Property | Description
--- | ---
CandidateStockCollector | Returns a collector object that holds candidate stocks to be merged with target stock.
Tag | Returns the Tag for this object.
TargetStockCollector | Returns a collector object that holds target stock for merge operation.

# 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.

# Property Detail

## CandidateStockCollector

`MergeStocksBuilder.``CandidateStockCollector`

  Returns a collector object that holds candidate stocks to be merged with target stock.

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

  Getter Method

  Signature `CandidateStockCollector`

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

  New in version NX10.0.0.

  License requirements: routing_base (“Routing Basic”)

## TargetStockCollector

`MergeStocksBuilder.``TargetStockCollector`

  Returns a collector object that holds target stock for merge operation.

  Candidate stocks will be merged with this stock , if possible

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

  Getter Method

  Signature `TargetStockCollector`

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

  New in version NX10.0.0.

  License requirements: routing_base (“Routing Basic”)

# Method Detail

## Validate

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