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:

Public Types
enum	SurroundingDataRecipeMethod { SurroundingDataRecipeMethodNone, SurroundingDataRecipeMethodProximitytoRoutingContent, SurroundingDataRecipeMethodManual }
	Represents the method to use to determine the surrounding data corresponding to the routing design content that has been loaded. More...

Public Member Functions
void	AppendSearchResultElementToSelectedList (const NXString &runID)
	Appends the Search Result Element corresponding to the given Run ID to the SelectedSearchResultElement list on NXOpen::Assemblies::MechanicalRoutingSubsetBuilder . More...

void	AppendSearchResultElementToSelectedList (const char *runID)
	Appends the Search Result Element corresponding to the given Run ID to the SelectedSearchResultElement list on NXOpen::Assemblies::MechanicalRoutingSubsetBuilder . More...

bool	Fixtures ()
	Returns an option for inclusion of fixtures DE's in the Routing Work. More...

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

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

bool	Insulation ()
	Returns an option for inclusion of insulation DE's in the Routing Work Subset. More...

void	RemoveAllSearchResultElementsFromSelectedList ()
	Removes all the Search Result Element from the SelectedSearchResultElement list on NXOpen::Assemblies::MechanicalRoutingSubsetBuilder . More...

void	RemoveSearchResultElementFromSelectedList (const NXString &runID)
	Removes the Search Result Element corresponding to the given Run ID from the SelectedSearchResultElement list on NXOpen::Assemblies::MechanicalRoutingSubsetBuilder . More...

void	RemoveSearchResultElementFromSelectedList (const char *runID)
	Removes the Search Result Element corresponding to the given Run ID from the SelectedSearchResultElement list on NXOpen::Assemblies::MechanicalRoutingSubsetBuilder . More...

void	SetFixtures (bool includeFixtures)
	Sets an option for inclusion of fixtures DE's in the Routing Work. More...

void	SetInsulation (bool includeInsulation)
	Sets an option for inclusion of insulation DE's in the Routing Work Subset. More...

void	SetRoutingSubsetAsWorkPart ()
	The builder may generate multiple subsets. More...

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

void	SetSurroundingDataProximityDistance (double surroundingDataProximityDistance)
	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...

void	SetSurroundingDataRecipeMethodType (NXOpen::Assemblies::MechanicalRoutingSubsetBuilder::SurroundingDataRecipeMethod surroundingDataRecipeMethod)
	Sets the routing recipes Assemblies::MechanicalRoutingSubsetBuilder Created in NX11.0.0. More...

double	SurroundingDataProximityDistance ()
	Returns 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...

NXOpen::Assemblies::MechanicalRoutingSubsetBuilder::SurroundingDataRecipeMethod	SurroundingDataRecipeMethodType ()
	Returns the routing recipes Assemblies::MechanicalRoutingSubsetBuilder Created in NX11.0.0. More...

NXOpen::Assemblies::SubsetBuilder *	UpdateSubsetUsingConfigurationContext (NXOpen::Assemblies::SubsetBuilder *inputSubsetBuilder)
	The routing subsets will be updated (e.g. More...

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder. More...

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder. More...

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder. More...

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. 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

enum NXOpen::Assemblies::MechanicalRoutingSubsetBuilder::SurroundingDataRecipeMethod

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
SurroundingDataRecipeMethodNone	none
SurroundingDataRecipeMethodProximitytoRoutingContent	proximityto routing content
SurroundingDataRecipeMethodManual	manual

Member Function Documentation

void NXOpen::Assemblies::MechanicalRoutingSubsetBuilder::AppendSearchResultElementToSelectedList ( const NXString & runID )

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 runid

void NXOpen::Assemblies::MechanicalRoutingSubsetBuilder::AppendSearchResultElementToSelectedList ( const char * runID )

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 runid

bool NXOpen::Assemblies::MechanicalRoutingSubsetBuilder::Fixtures ( )

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

Created in NX11.0.0.

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

NXOpen::PDM::ConfigurationContextBuilder* NXOpen::Assemblies::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.

Returns: Created in NX11.0.0.

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

NXOpen::Assemblies::SubsetBuilder* NXOpen::Assemblies::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.

Returns: Created in NX11.0.0.

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

bool NXOpen::Assemblies::MechanicalRoutingSubsetBuilder::Insulation ( )

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

Created in NX11.0.0.

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

void NXOpen::Assemblies::MechanicalRoutingSubsetBuilder::RemoveAllSearchResultElementsFromSelectedList ( )

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")

void NXOpen::Assemblies::MechanicalRoutingSubsetBuilder::RemoveSearchResultElementFromSelectedList ( const NXString & runID )

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 runid

void NXOpen::Assemblies::MechanicalRoutingSubsetBuilder::RemoveSearchResultElementFromSelectedList ( const char * runID )

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 runid

void NXOpen::Assemblies::MechanicalRoutingSubsetBuilder::SetFixtures ( bool includeFixtures )

Sets an option for inclusion of fixtures DE's in the Routing Work.

Created in NX11.0.0.

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

Parameters

includeFixtures includefixtures

void NXOpen::Assemblies::MechanicalRoutingSubsetBuilder::SetInsulation ( bool includeInsulation )

Sets an option for inclusion of insulation DE's in the Routing Work Subset.

Created in NX11.0.0.

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

Parameters

includeInsulation includeinsulation

void NXOpen::Assemblies::MechanicalRoutingSubsetBuilder::SetRoutingSubsetAsWorkPart ( )

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")

void NXOpen::Assemblies::MechanicalRoutingSubsetBuilder::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.

Created in NX11.0.0.

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

Parameters

subsetBuilder subsetbuilder

void NXOpen::Assemblies::MechanicalRoutingSubsetBuilder::SetSurroundingDataProximityDistance ( double surroundingDataProximityDistance )

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 : None

Parameters

surroundingDataProximityDistance surroundingdataproximitydistance

void NXOpen::Assemblies::MechanicalRoutingSubsetBuilder::SetSurroundingDataRecipeMethodType ( NXOpen::Assemblies::MechanicalRoutingSubsetBuilder::SurroundingDataRecipeMethod surroundingDataRecipeMethod )

Sets the routing recipes Assemblies::MechanicalRoutingSubsetBuilder
Created in NX11.0.0.

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

Parameters

surroundingDataRecipeMethod surroundingdatarecipemethod

double NXOpen::Assemblies::MechanicalRoutingSubsetBuilder::SurroundingDataProximityDistance ( )

Returns 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 : None

NXOpen::Assemblies::MechanicalRoutingSubsetBuilder::SurroundingDataRecipeMethod NXOpen::Assemblies::MechanicalRoutingSubsetBuilder::SurroundingDataRecipeMethodType ( )

Returns the routing recipes Assemblies::MechanicalRoutingSubsetBuilder
Created in NX11.0.0.

License requirements : None

NXOpen::Assemblies::SubsetBuilder* NXOpen::Assemblies::MechanicalRoutingSubsetBuilder::UpdateSubsetUsingConfigurationContext ( NXOpen::Assemblies::SubsetBuilder * inputSubsetBuilder )

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.

Returns: Created in NX11.0.0.

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

Parameters

inputSubsetBuilder inputsubsetbuilder

The documentation for this class was generated from the following file:

Assemblies_MechanicalRoutingSubsetBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation