NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Properties | List of all members
NXOpen.Assemblies.MechanicalRoutingSubsetBuilder Class Reference

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

Inheritance diagram for NXOpen.Assemblies.MechanicalRoutingSubsetBuilder:
NXOpen.Builder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  SurroundingDataRecipeMethod { None, ProximitytoRoutingContent, Manual }
 Represents the method to use to determine the surrounding data corresponding to the routing design content that has been loaded. More...
 

Public Member Functions

unsafe void AppendSearchResultElementToSelectedList (string runID)
 Appends the Search Result Element corresponding to the given Run ID to the SelectedSearchResultElement list on NXOpen.Assemblies.MechanicalRoutingSubsetBuilder . More...
 
unsafe
NXOpen.PDM.ConfigurationContextBuilder 
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. More...
 
unsafe
NXOpen.Assemblies.SubsetBuilder 
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. More...
 
unsafe void RemoveAllSearchResultElementsFromSelectedList ()
 Removes all the Search Result Element from the SelectedSearchResultElement list on NXOpen.Assemblies.MechanicalRoutingSubsetBuilder . More...
 
unsafe void RemoveSearchResultElementFromSelectedList (string runID)
 Removes the Search Result Element corresponding to the given Run ID from the SelectedSearchResultElement list on NXOpen.Assemblies.MechanicalRoutingSubsetBuilder . More...
 
unsafe void SetRoutingSubsetAsWorkPart ()
 The builder may generate multiple subsets. More...
 
unsafe void SetSearchSubsetBuilder (NXOpen.Assemblies.SubsetBuilder subsetBuilder)
 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. More...
 
unsafe
NXOpen.Assemblies.SubsetBuilder 
UpdateSubsetUsingConfigurationContext (NXOpen.Assemblies.SubsetBuilder inputSubsetBuilder)
 The routing subsets will be updated (e. More...
 
- Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject Commit ()
 Commits any edits that have been applied to the builder. More...
 
unsafe void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
unsafe NXOpen.NXObject[] GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
unsafe NXOpen.NXObject GetObject ()
 Returns the object currently being edited by this builder. More...
 
unsafe void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

unsafe bool Fixtures [get, set]
 Returns or sets an option for inclusion of fixtures DE's in the Routing Work. More...
 
unsafe bool Insulation [get, set]
 Returns or sets an option for inclusion of insulation DE's in the Routing Work Subset. More...
 
unsafe double SurroundingDataProximityDistance [get, set]
 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. More...
 
unsafe
NXOpen.Assemblies.MechanicalRoutingSubsetBuilder.SurroundingDataRecipeMethod 
SurroundingDataRecipeMethodType [get, set]
 Returns or sets the routing recipes Assemblies.MechanicalRoutingSubsetBuilder More...
 
- Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder PreviewBuilder [get]
 Returns the preview builder subobject. More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

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

Created in NX11.0.0

Member Enumeration Documentation

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

1. None : No surrounding data to be loaded. 2. ProximityRoutingContent : This means surrounding data for the runs, this is related to the DE's that are in proximity to the DEs constituting the run. 3. Manual: An empty Surrounding Object Subset will be created

Enumerator
None 
ProximitytoRoutingContent 
Manual 

Member Function Documentation

unsafe void NXOpen.Assemblies.MechanicalRoutingSubsetBuilder.AppendSearchResultElementToSelectedList ( string  runID)
inline

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

Created in NX11.0.0

License requirements: nx_4gd_integration ("4th Generation Design")

Parameters
runID
unsafe NXOpen.PDM.ConfigurationContextBuilder NXOpen.Assemblies.MechanicalRoutingSubsetBuilder.GetConfigurationContextBuilder ( )
inline

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.

Created in NX11.0.0

License requirements: nx_4gd_integration ("4th Generation Design")

Returns
unsafe NXOpen.Assemblies.SubsetBuilder NXOpen.Assemblies.MechanicalRoutingSubsetBuilder.GetSearchSubsetBuilder ( )
inline

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.

Created in NX11.0.0

License requirements: nx_4gd_integration ("4th Generation Design")

Returns
unsafe void NXOpen.Assemblies.MechanicalRoutingSubsetBuilder.RemoveAllSearchResultElementsFromSelectedList ( )
inline

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

Created in NX11.0.0

License requirements: nx_4gd_integration ("4th Generation Design")

unsafe void NXOpen.Assemblies.MechanicalRoutingSubsetBuilder.RemoveSearchResultElementFromSelectedList ( string  runID)
inline

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

Created in NX11.0.0

License requirements: nx_4gd_integration ("4th Generation Design")

Parameters
runID
unsafe void NXOpen.Assemblies.MechanicalRoutingSubsetBuilder.SetRoutingSubsetAsWorkPart ( )
inline

The builder may generate multiple subsets.

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

Created in NX11.0.0

License requirements: nx_4gd_integration ("4th Generation Design")

unsafe void NXOpen.Assemblies.MechanicalRoutingSubsetBuilder.SetSearchSubsetBuilder ( NXOpen.Assemblies.SubsetBuilder  subsetBuilder)
inline

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.

Created in NX11.0.0

License requirements: nx_4gd_integration ("4th Generation Design")

Parameters
subsetBuilder
unsafe NXOpen.Assemblies.SubsetBuilder NXOpen.Assemblies.MechanicalRoutingSubsetBuilder.UpdateSubsetUsingConfigurationContext ( NXOpen.Assemblies.SubsetBuilder  inputSubsetBuilder)
inline

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.

Created in NX11.0.0

License requirements: nx_4gd_integration ("4th Generation Design")

Parameters
inputSubsetBuilder
Returns

Property Documentation

unsafe bool NXOpen.Assemblies.MechanicalRoutingSubsetBuilder.Fixtures
getset

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

Created in NX11.0.0

License requirements to get this property: nx_4gd_integration ("4th Generation Design")

License requirements to set this property: nx_4gd_integration ("4th Generation Design")

unsafe bool NXOpen.Assemblies.MechanicalRoutingSubsetBuilder.Insulation
getset

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

Created in NX11.0.0

License requirements to get this property: nx_4gd_integration ("4th Generation Design")

License requirements to set this property: nx_4gd_integration ("4th Generation Design")

unsafe double NXOpen.Assemblies.MechanicalRoutingSubsetBuilder.SurroundingDataProximityDistance
getset

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

Created in NX11.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Assemblies.MechanicalRoutingSubsetBuilder.SurroundingDataRecipeMethod NXOpen.Assemblies.MechanicalRoutingSubsetBuilder.SurroundingDataRecipeMethodType
getset

Returns or sets the routing recipes Assemblies.MechanicalRoutingSubsetBuilder

Created in NX11.0.0

License requirements to get this property: None.

License requirements to set this property: nx_4gd_integration ("4th Generation Design")


The documentation for this class was generated from the following file:
Copyright 2019 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.