UnifyPathBuilder Class

class NXOpen.Routing.UnifyPathBuilder

Bases: NXOpen.Builder

Builder to unify Routing.Stock and Assemblies.Component based on specified characteristic values.

The builder takes a set of objects and replaces them with new objects that matches the given characterstics. To create a new instance of this class, use NXOpen.Routing.RouteManager.CreateUnifyPathBuilder()

New in version NX7.5.0.

Properties

Property Description
ReferenceObject Returns the reference object used to extract characteristics to unify.
RouteObjectCollector Returns the routing object collector to select objects to unify.
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.
GetUnifyCharacteristics Returns Routing.CharacteristicList to be used to find matching Routing.Stock and Assemblies.Component to replace.
SetUnifyCharacteristics Sets the characteristics to be applied
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

ReferenceObject

UnifyPathBuilder.ReferenceObject

Returns the reference object used to extract characteristics to unify.

-------------------------------------

Getter Method

Signature ReferenceObject

Returns:
Return type:NXOpen.SelectNXObject

New in version NX7.5.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

RouteObjectCollector

UnifyPathBuilder.RouteObjectCollector

Returns the routing object collector to select objects to unify.

-------------------------------------

Getter Method

Signature RouteObjectCollector

Returns:
Return type:NXOpen.Routing.RouteObjectCollector

New in version NX7.5.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

Method Detail

GetUnifyCharacteristics

UnifyPathBuilder.GetUnifyCharacteristics

Returns Routing.CharacteristicList to be used to find matching Routing.Stock and Assemblies.Component to replace.

Signature GetUnifyCharacteristics()

Returns:The characteristics to use in finding a replacement for the given object.
Return type:NXOpen.Routing.CharacteristicList

New in version NX7.5.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

SetUnifyCharacteristics

UnifyPathBuilder.SetUnifyCharacteristics

Sets the characteristics to be applied

Signature SetUnifyCharacteristics(charxType, charxName, charxValue)

Parameters:
  • charxType (NXOpen.NXObjectAttributeType) –
  • charxName (str) –
  • charxValue (str) – The characteristics to use in finding a replacement for the given object.

New in version NX8.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

Validate

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