MechanicalRoutingSubsetBuilder Class

class NXOpen.Assemblies.MechanicalRoutingSubsetBuilder

Bases: NXOpen.Builder

A MechanicalRoutingSubsetBuilder is used to create/edit Subsets NXOpen.Assemblies.Subset that are used to define the context needed to perform a Mechanical Routing Design activity.

The builder may generate multiple subsets. The content of these subsets can be classified into “Work” content - the elements of the Routing design that the user would like to focus on and “Surrounding Data” content - the 3D content that surrounds the Routing design. The subset definition process utilizes the concept of a Run ja class TBD by NX P and ID while defining the recipe terms needed for the subsets. To create a new instance of this class, use NXOpen.Assemblies.SubsetCollection.CreateMechanicalRoutingSubsetBuilderForSurroundingEdit()

New in version NX11.0.0.

Properties

Property	Description
Fixtures	Returns or sets an option for inclusion of fixtures DE’s in the Routing Work.
Insulation	Returns or sets an option for inclusion of insulation DE’s in the Routing Work Subset.
SurroundingDataProximityDistance	Returns or sets a proximity to Routing Content method has been selected to determine the surrounding content then this is the distance value used to perform the evaluation.
SurroundingDataRecipeMethodType	Returns or sets the routing recipes Assemblies.MechanicalRoutingSubsetBuilder
Tag	Returns the Tag for this object.

Methods

Method	Description
AppendSearchResultElementToSelectedList	Appends the Search Result Element corresponding to the given Run ID to the SelectedSearchResultElement list on NXOpen.Assemblies.MechanicalRoutingSubsetBuilder.
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.
GetConfigurationContextBuilder	Returns the configuration context builder which will be used by user to set revision rule or effectivity and then user needs to use NXOpen.Assemblies.FindInCollaborativeDesign to search for runs using object type RunElement.
GetObject	Returns the object currently being edited by this builder.
GetSearchSubsetBuilder	The subset builder which is used for searching runs, the user will have to use NXOpen.Assemblies.FindInCollaborativeDesign to search for runs using object type RunElement.
RemoveAllSearchResultElementsFromSelectedList	Removes all the Search Result Element from the SelectedSearchResultElement list on NXOpen.Assemblies.MechanicalRoutingSubsetBuilder.
RemoveSearchResultElementFromSelectedList	Removes the Search Result Element corresponding to the given Run ID from the SelectedSearchResultElement list on NXOpen.Assemblies.MechanicalRoutingSubsetBuilder.
SetRoutingSubsetAsWorkPart	The builder may generate multiple subsets.
SetSearchSubsetBuilder	Sets the subset builder which needs to be set by user to search runs, the user will have to use NXOpen.Assemblies.FindInCollaborativeDesign to search for runs using object type RunElement.
ShowResults	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
UpdateSubsetUsingConfigurationContext	The routing subsets will be updated (e.
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

MechanicalRoutingSubsetBuilderSurroundingDataRecipeMethod Enumeration

Represents the method to use to determine the surrounding data corresponding to the routing design content that has been loaded.

Property Detail

Fixtures

MechanicalRoutingSubsetBuilder.Fixtures

Returns or sets an option for inclusion of fixtures DE’s in the Routing Work.

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

Getter Method

Signature Fixtures

Returns: Return type:bool

New in version NX11.0.0.

License requirements: nx_4gd_integration (“4th Generation Design”)

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

Setter Method

Signature Fixtures

Parameters:includeFixtures (bool) –

New in version NX11.0.0.

License requirements: nx_4gd_integration (“4th Generation Design”)

Insulation

MechanicalRoutingSubsetBuilder.Insulation

Returns or sets an option for inclusion of insulation DE’s in the Routing Work Subset.

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

Getter Method

Signature Insulation

Returns: Return type:bool

New in version NX11.0.0.

License requirements: nx_4gd_integration (“4th Generation Design”)

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

Setter Method

Signature Insulation

Parameters:includeInsulation (bool) –

New in version NX11.0.0.

License requirements: nx_4gd_integration (“4th Generation Design”)

SurroundingDataProximityDistance

MechanicalRoutingSubsetBuilder.SurroundingDataProximityDistance

Returns or sets a proximity to Routing Content method has been selected to determine the surrounding content then this is the distance value used to perform the evaluation.

The units are in meters

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

Getter Method

Signature SurroundingDataProximityDistance

Returns: Return type:float

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature SurroundingDataProximityDistance

Parameters:surroundingDataProximityDistance (float) –

New in version NX11.0.0.

License requirements: None.

SurroundingDataRecipeMethodType

MechanicalRoutingSubsetBuilder.SurroundingDataRecipeMethodType

Returns or sets the routing recipes Assemblies.MechanicalRoutingSubsetBuilder

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

Getter Method

Signature SurroundingDataRecipeMethodType

Returns: Return type:NXOpen.Assemblies.MechanicalRoutingSubsetBuilderSurroundingDataRecipeMethod

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature SurroundingDataRecipeMethodType

Parameters:surroundingDataRecipeMethod (NXOpen.Assemblies.MechanicalRoutingSubsetBuilderSurroundingDataRecipeMethod) –

New in version NX11.0.0.

License requirements: nx_4gd_integration (“4th Generation Design”)

Method Detail

AppendSearchResultElementToSelectedList

MechanicalRoutingSubsetBuilder.AppendSearchResultElementToSelectedList

Appends the Search Result Element corresponding to the given Run ID to the SelectedSearchResultElement list on NXOpen.Assemblies.MechanicalRoutingSubsetBuilder.

Signature AppendSearchResultElementToSelectedList(runID)

Parameters:runID (str) –

New in version NX11.0.0.

License requirements: nx_4gd_integration (“4th Generation Design”)

GetConfigurationContextBuilder

MechanicalRoutingSubsetBuilder.GetConfigurationContextBuilder

Returns the configuration context builder which will be used by user to set revision rule or effectivity and then user needs to use NXOpen.Assemblies.FindInCollaborativeDesign to search for runs using object type RunElement.

This is the builder which will be returned whenever you are creating new subsets. This will be NULL in edit mode scenario.

Signature GetConfigurationContextBuilder()

Returns: Return type:NXOpen.PDM.ConfigurationContextBuilder

New in version NX11.0.0.

License requirements: nx_4gd_integration (“4th Generation Design”)

GetSearchSubsetBuilder

MechanicalRoutingSubsetBuilder.GetSearchSubsetBuilder

The subset builder which is used for searching runs, the user will have to use NXOpen.Assemblies.FindInCollaborativeDesign to search for runs using object type RunElement.

Signature GetSearchSubsetBuilder()

Returns: Return type:NXOpen.Assemblies.SubsetBuilder

New in version NX11.0.0.

License requirements: nx_4gd_integration (“4th Generation Design”)

RemoveAllSearchResultElementsFromSelectedList

MechanicalRoutingSubsetBuilder.RemoveAllSearchResultElementsFromSelectedList

Removes all the Search Result Element from the SelectedSearchResultElement list on NXOpen.Assemblies.MechanicalRoutingSubsetBuilder.

Signature RemoveAllSearchResultElementsFromSelectedList()

New in version NX11.0.0.

License requirements: nx_4gd_integration (“4th Generation Design”)

RemoveSearchResultElementFromSelectedList

MechanicalRoutingSubsetBuilder.RemoveSearchResultElementFromSelectedList

Removes the Search Result Element corresponding to the given Run ID from the SelectedSearchResultElement list on NXOpen.Assemblies.MechanicalRoutingSubsetBuilder.

Signature RemoveSearchResultElementFromSelectedList(runID)

Parameters:runID (str) –

New in version NX11.0.0.

License requirements: nx_4gd_integration (“4th Generation Design”)

SetRoutingSubsetAsWorkPart

MechanicalRoutingSubsetBuilder.SetRoutingSubsetAsWorkPart

The builder may generate multiple subsets.

This API will set the Routing Design Subset as the work part.

Signature SetRoutingSubsetAsWorkPart()

New in version NX11.0.0.

License requirements: nx_4gd_integration (“4th Generation Design”)

SetSearchSubsetBuilder

MechanicalRoutingSubsetBuilder.SetSearchSubsetBuilder

Sets the subset builder which needs to be set by user to search runs, the user will have to use NXOpen.Assemblies.FindInCollaborativeDesign to search for runs using object type RunElement.

Signature SetSearchSubsetBuilder(subsetBuilder)

Parameters:subsetBuilder (NXOpen.Assemblies.SubsetBuilder) –

New in version NX11.0.0.

License requirements: nx_4gd_integration (“4th Generation Design”)

UpdateSubsetUsingConfigurationContext

MechanicalRoutingSubsetBuilder.UpdateSubsetUsingConfigurationContext

The routing subsets will be updated (e.

g. revision rule, effectivity) using the information available on the ConfigurationContext if the input is NULL. In case of valid input the corresponding subset will be updated with the information available on the ConfigurationContext.

Signature UpdateSubsetUsingConfigurationContext(inputSubsetBuilder)

Parameters:inputSubsetBuilder (NXOpen.Assemblies.SubsetBuilder) – Returns: Return type:NXOpen.Assemblies.SubsetBuilder

New in version NX11.0.0.

License requirements: nx_4gd_integration (“4th Generation Design”)

Validate

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