BulkReplacementBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# BulkReplacementBuilder Class

class `NXOpen.MechanicalRouting.``BulkReplacementBuilder`

  Bases: `NXOpen.Routing.BulkReplacementBuilder`

  Builder class for Bulk Replacement which manages replacement operations on design elements

  To create a new instance of this class, use `NXOpen.MechanicalRouting.BuilderFactory.CreateBulkReplacementBuilder()`

  New in version NX12.0.0.

# Properties

Property | Description
--- | ---
ReferenceObject | Returns the reference object used to extract characteristics for Bulk Replacement
RouteObjectCollector | Returns the Routing object collector
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
ClearAttributeForAllObjects | The attribute value clear method for all objects
ClearAttributeForObject | The object attribute value clear method
Commit | Commits any edits that have been applied to the builder.
CopySearchResultsToObject | The method that copies the search results from one object to another
Destroy | Deletes the builder, and cleans up any objects created by the builder.
GetAttributeForObject | The object attribute value method getter
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.
GetPartLayer | The method that gets the layer used for newly replaced objects
GetPartLibraryValuesForAttributeForObject | The method gets the part libray values for a given attribute for the specified object
GetPartReferenceSet | The method that gets the reference set used for newly replaced objects
GetReplacementMethodForObject | The replacement method getter
GetReplacementObjectIdentifierForObject | The replacement object identifier getter
GetReplacementObjectIdentifiersFromSearchResultsForObject | The possible replacement object identifiers method getter
GetRetainReasonForObject | The retain reason getter
GetSelectedObjectValuesForAttribute | The method that retrieves all the values for a given attribute from all the objects
GetValueForAttributeFromReferenceObject | The method that returns the value of an attribute from the reference object
SearchForReplacementForObject | The method that initiates a search for the replacement object
SearchForReplacementForObjectOnAttributes | The method that initiates a search for the replacement object using on the passed in attributes as criteria
SetAttributeForAllObjects | The attribute value setter for all objects
SetAttributeForObject | The object attribute value method setter
SetAttributeValueForObjectFromReferenceObject | The method that sets the attribute value from the reference object on the specifiec object
SetPartLayer | The method that sets the layer used for newly replaced objects
SetPartReferenceSet | The method that sets the reference set used for newly replaced objects
SetReplacementClassificationObjectForObject | The replacement object method setter
SetReplacementMethodForAllObjects | The replacement method setter for all objects
SetReplacementMethodForObject | The replacement method setter
SetReplacementObjectIdentifierForObject | The replacement object identifier method setter
SetReplacementPartSpecificationForObject | The replacement part specification method setter
SetSequenceOfObjectReplacement | The method that sets the sequence of object replacement
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.

# Method Detail

## Validate

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