Provides utilities to to eliminate certain inaccessible objects from the part file. More...

Inheritance diagram for NXOpen::PartCleanup:

Public Types
enum	CleanupParts { CleanupPartsWork, CleanupPartsComponents, CleanupPartsAll }
	Which parts to clean up. More...

enum	DeleteGroups { DeleteGroupsNone, DeleteGroupsUnnamed, DeleteGroupsAll }
	Which empty groups to clean up. More...

enum	ResetComponentDisplayAction { ResetComponentDisplayActionNo, ResetComponentDisplayActionRemoveRedundantChanges, ResetComponentDisplayActionRemoveAllChanges }
	Assembly display clean up action. More...

Public Member Functions
bool	CleanupAssemblyConstraints ()
	Returns the option that specifies whether to cleanup assembly constraints. More...

bool	CleanupCAMObjects ()
	Returns the option that specifies whether to delete or fix any corrupt internal CAM objects. More...

bool	CleanupDraftingObjects ()
	Returns the option that specifies whether to perform drafting cleanup. More...

bool	CleanupFeatureData ()
	Returns the option that specifies whether to perform solid cleanup. More...

bool	CleanupMatingData ()
	Returns the option that specifies whether to cleanup mating data. More...

bool	CleanupMotionData ()
	Returns the option which determines if the motion cleanup option should be performed. More...

bool	CleanupPartFamilyData ()
	Returns the option that specifies if the part family data cleanup should be performed. More...

bool	CleanupRoutingData ()
	Returns the option which determines if the routing part cleanup option should be performed. More...

bool	DeleteBrokenInterpartLinks ()
	Returns the option that specifies whether or not to delete all inter-part links where one or more components in that inter-part link have been removed. More...

bool	DeleteDuplicateLights ()
	Returns the option that specifies whether to delete duplicate light source objects from the part file. More...

bool	DeleteInvalidAttributes ()
	Returns the option that specifies whether to delete all invalid user attributes from the part file. More...

bool	DeleteMaterials ()
	Returns the option that specifies whether to delete all materials from the part file. More...

bool	DeleteSpreadSheetData ()
	Returns the option that specifies whether to delete all spreadsheets from the part file. More...

bool	DeleteUnusedExpressions ()
	Returns the option that specifies whether to delete expressions that are not used in the part. More...

bool	DeleteUnusedExtractReferences ()
	Returns the option that specifies whether to delete all unused edge/face references in extract features from the part file. More...

bool	DeleteUnusedFonts ()
	Returns the option that specifies whether to remove character fonts that are not used in any drafting text in the current part. More...

bool	DeleteUnusedObjects ()
	Returns the option that specifies whether to delete all extraneous objects from the work part Created in NX3.0.0. More...

bool	DeleteUnusedUnits ()
	Returns the option that specifies whether to remove character fonts that are not used in any drafting text in the current part. More...

bool	DeleteVisualEditorData ()
	Returns the option that specifies whether to delete Visual Editor data from the part file. More...

void	DoCleanup ()
	Actually performs the part cleanup operation according to the properties set on this object Created in NX3.0.0. More...

bool	FixOffplaneSketchCurves ()
	Returns the option that specifies whether to fix off-plane sketch curves. More...

NXOpen::PartCleanup::DeleteGroups	GroupsToDelete ()
	Returns the option that specifies what empty groups should be deleted. More...

NXOpen::PartCleanup::CleanupParts	PartsToCleanup ()
	Returns the option that specifies what parts will be cleaned up when PartCleanup::DoCleanup is called. More...

void	Reset ()
	Resets all the properties back to the default values (i.e. More...

NXOpen::PartCleanup::ResetComponentDisplayAction	ResetComponentDisplay ()
	Returns the option that specifies whether to remove assembly-specific geometry in component parts. More...

void	SetCleanupAssemblyConstraints (bool cleanupOption)
	Sets the option that specifies whether to cleanup assembly constraints. More...

void	SetCleanupCAMObjects (bool cleanupOption)
	Sets the option that specifies whether to delete or fix any corrupt internal CAM objects. More...

void	SetCleanupDraftingObjects (bool cleanupOption)
	Sets the option that specifies whether to perform drafting cleanup. More...

void	SetCleanupFeatureData (bool cleanupOption)
	Sets the option that specifies whether to perform solid cleanup. More...

void	SetCleanupMatingData (bool cleanupOption)
	Sets the option that specifies whether to cleanup mating data. More...

void	SetCleanupMotionData (bool cleanupOption)
	Sets the option which determines if the motion cleanup option should be performed. More...

void	SetCleanupPartFamilyData (bool cleanupOption)
	Sets the option that specifies if the part family data cleanup should be performed. More...

void	SetCleanupRoutingData (bool cleanupOption)
	Sets the option which determines if the routing part cleanup option should be performed. More...

void	SetDeleteBrokenInterpartLinks (bool cleanupOption)
	Sets the option that specifies whether or not to delete all inter-part links where one or more components in that inter-part link have been removed. More...

void	SetDeleteDuplicateLights (bool cleanupOption)
	Sets the option that specifies whether to delete duplicate light source objects from the part file. More...

void	SetDeleteInvalidAttributes (bool cleanupOption)
	Sets the option that specifies whether to delete all invalid user attributes from the part file. More...

void	SetDeleteMaterials (bool cleanupOption)
	Sets the option that specifies whether to delete all materials from the part file. More...

void	SetDeleteSpreadSheetData (bool cleanupOption)
	Sets the option that specifies whether to delete all spreadsheets from the part file. More...

void	SetDeleteUnusedExpressions (bool cleanupOption)
	Sets the option that specifies whether to delete expressions that are not used in the part. More...

void	SetDeleteUnusedExtractReferences (bool opt)
	Sets the option that specifies whether to delete all unused edge/face references in extract features from the part file. More...

void	SetDeleteUnusedFonts (bool cleanupOption)
	Sets the option that specifies whether to remove character fonts that are not used in any drafting text in the current part. More...

void	SetDeleteUnusedObjects (bool cleanupOption)
	Sets the option that specifies whether to delete all extraneous objects from the work part Created in NX3.0.0. More...

void	SetDeleteUnusedUnits (bool cleanupOption)
	Sets the option that specifies whether to remove character fonts that are not used in any drafting text in the current part. More...

void	SetDeleteVisualEditorData (bool cleanupOption)
	Sets the option that specifies whether to delete Visual Editor data from the part file. More...

void	SetFixOffplaneSketchCurves (bool cleanupOption)
	Sets the option that specifies whether to fix off-plane sketch curves. More...

void	SetGroupsToDelete (NXOpen::PartCleanup::DeleteGroups cleanupOption)
	Sets the option that specifies what empty groups should be deleted. More...

void	SetPartsToCleanup (NXOpen::PartCleanup::CleanupParts cleanupOption)
	Sets the option that specifies what parts will be cleaned up when PartCleanup::DoCleanup is called. More...

void	SetResetComponentDisplay (NXOpen::PartCleanup::ResetComponentDisplayAction cleanupOption)
	Sets the option that specifies whether to remove assembly-specific geometry in component parts. More...

void	SetTurnOffHighlighting (bool cleanupOption)
	Sets the option that specifies whether to turn off highlighting for all displayable objects in the displayed part. More...

bool	TurnOffHighlighting ()
	Returns the option that specifies whether to turn off highlighting for all displayable objects in the displayed part. More...

virtual	~PartCleanup ()
	Free resources associated with the instance. More...

Public Member Functions inherited from NXOpen::TransientObject
void *	GetHandle ()
	Handle of the internal object represented by this object. More...

Detailed Description

Provides utilities to to eliminate certain inaccessible objects from the part file.

To use this utility, first create an instance of this class by calling Session::NewPartCleanup . Then, set any part cleanup actions that you wish to be performed by setting the appropriate properties on this class. By default, all the properties are set to "false" or "none". Once all the properties are set, then call the PartCleanup::DoCleanup method to actually perform the cleanup action.

For more information on what the various part cleanup options do, see the Part Cleanup Options Dialog section of the Gateway Help.

Created in NX3.0.0.

Member Enumeration Documentation

enum NXOpen::PartCleanup::CleanupParts

Which parts to clean up.

Enumerator
CleanupPartsWork	clean up the work part only
CleanupPartsComponents	clean up the work part and its components
CleanupPartsAll	clean up all loaded parts

enum NXOpen::PartCleanup::DeleteGroups

Which empty groups to clean up.

Enumerator
DeleteGroupsNone	delete none of the empty groups
DeleteGroupsUnnamed	delete only the unnamed empty groups
DeleteGroupsAll	delete all the empty groups

enum NXOpen::PartCleanup::ResetComponentDisplayAction

Assembly display clean up action.

Enumerator
ResetComponentDisplayActionNo	do nothing
ResetComponentDisplayActionRemoveRedundantChanges	only remove changes that will not affect current display.
ResetComponentDisplayActionRemoveAllChanges	remove all changes

Constructor & Destructor Documentation

virtual NXOpen::PartCleanup::~PartCleanup ( )

virtual

Free resources associated with the instance.

After this method is called, it is illegal to use the object. In .NET, this method is automatically called when the object is deleted by the garbage collector.
Created in NX3.0.0.

License requirements : None

Member Function Documentation

bool NXOpen::PartCleanup::CleanupAssemblyConstraints ( )

Returns the option that specifies whether to cleanup assembly constraints.

Created in NX7.5.5.

License requirements : None

bool NXOpen::PartCleanup::CleanupCAMObjects ( )

Returns the option that specifies whether to delete or fix any corrupt internal CAM objects.

Created in NX3.0.0.

License requirements : None

bool NXOpen::PartCleanup::CleanupDraftingObjects ( )

Returns the option that specifies whether to perform drafting cleanup.

Created in NX3.0.0.

License requirements : None

bool NXOpen::PartCleanup::CleanupFeatureData ( )

Returns the option that specifies whether to perform solid cleanup.

Created in NX3.0.0.

License requirements : None

bool NXOpen::PartCleanup::CleanupMatingData ( )

Returns the option that specifies whether to cleanup mating data.

Created in NX3.0.0.

License requirements : None

bool NXOpen::PartCleanup::CleanupMotionData ( )

Returns the option which determines if the motion cleanup option should be performed.

Created in NX12.0.0.

License requirements : None

bool NXOpen::PartCleanup::CleanupPartFamilyData ( )

Returns the option that specifies if the part family data cleanup should be performed.

Created in NX12.0.0.

License requirements : None

bool NXOpen::PartCleanup::CleanupRoutingData ( )

Returns the option which determines if the routing part cleanup option should be performed.

Created in NX7.5.4.

License requirements : None

bool NXOpen::PartCleanup::DeleteBrokenInterpartLinks ( )

Returns the option that specifies whether or not to delete all inter-part links where one or more components in that inter-part link have been removed.

Created in NX5.0.0.

License requirements : None

bool NXOpen::PartCleanup::DeleteDuplicateLights ( )

Returns the option that specifies whether to delete duplicate light source objects from the part file.

Created in NX7.5.3.

License requirements : None

bool NXOpen::PartCleanup::DeleteInvalidAttributes ( )

Returns the option that specifies whether to delete all invalid user attributes from the part file.

Created in NX8.0.3.

License requirements : None

bool NXOpen::PartCleanup::DeleteMaterials ( )

Returns the option that specifies whether to delete all materials from the part file.

Created in NX7.5.2.

License requirements : None

bool NXOpen::PartCleanup::DeleteSpreadSheetData ( )

Returns the option that specifies whether to delete all spreadsheets from the part file.

Created in NX3.0.0.

License requirements : None

bool NXOpen::PartCleanup::DeleteUnusedExpressions ( )

Returns the option that specifies whether to delete expressions that are not used in the part.

Created in NX3.0.0.

License requirements : None

bool NXOpen::PartCleanup::DeleteUnusedExtractReferences ( )

Returns the option that specifies whether to delete all unused edge/face references in extract features from the part file.

Created in NX11.0.1.

License requirements : None

bool NXOpen::PartCleanup::DeleteUnusedFonts ( )

Returns the option that specifies whether to remove character fonts that are not used in any drafting text in the current part.

Created in NX3.0.0.

License requirements : None

bool NXOpen::PartCleanup::DeleteUnusedObjects ( )

Returns the option that specifies whether to delete all extraneous objects from the work part
Created in NX3.0.0.

License requirements : None

bool NXOpen::PartCleanup::DeleteUnusedUnits ( )

Returns the option that specifies whether to remove character fonts that are not used in any drafting text in the current part.

Created in NX12.0.0.

License requirements : None

bool NXOpen::PartCleanup::DeleteVisualEditorData ( )

Returns the option that specifies whether to delete Visual Editor data from the part file.

Created in NX3.0.0.

License requirements : None

void NXOpen::PartCleanup::DoCleanup ( )

Actually performs the part cleanup operation according to the properties set on this object
Created in NX3.0.0.

License requirements : None

bool NXOpen::PartCleanup::FixOffplaneSketchCurves ( )

Returns the option that specifies whether to fix off-plane sketch curves.

Created in NX3.0.0.

License requirements : None

NXOpen::PartCleanup::DeleteGroups NXOpen::PartCleanup::GroupsToDelete ( )

Returns the option that specifies what empty groups should be deleted.

Created in NX3.0.0.

License requirements : None

NXOpen::PartCleanup::CleanupParts NXOpen::PartCleanup::PartsToCleanup ( )

Returns the option that specifies what parts will be cleaned up when PartCleanup::DoCleanup is called.

Created in NX3.0.0.

License requirements : None

void NXOpen::PartCleanup::Reset ( )

Resets all the properties back to the default values (i.e.

everything turned off).
Created in NX3.0.0.

License requirements : None

NXOpen::PartCleanup::ResetComponentDisplayAction NXOpen::PartCleanup::ResetComponentDisplay ( )

Returns the option that specifies whether to remove assembly-specific geometry in component parts.

Created in NX3.0.0.

License requirements : None

void NXOpen::PartCleanup::SetCleanupAssemblyConstraints ( bool cleanupOption )

Sets the option that specifies whether to cleanup assembly constraints.

Created in NX7.5.5.

License requirements : None

Parameters

cleanupOption cleanup option

void NXOpen::PartCleanup::SetCleanupCAMObjects ( bool cleanupOption )

Sets the option that specifies whether to delete or fix any corrupt internal CAM objects.

Created in NX3.0.0.

License requirements : None

Parameters

cleanupOption cleanup option

void NXOpen::PartCleanup::SetCleanupDraftingObjects ( bool cleanupOption )

Sets the option that specifies whether to perform drafting cleanup.

Created in NX3.0.0.

License requirements : None

Parameters

cleanupOption cleanup option

void NXOpen::PartCleanup::SetCleanupFeatureData ( bool cleanupOption )

Sets the option that specifies whether to perform solid cleanup.

Created in NX3.0.0.

License requirements : None

Parameters

cleanupOption cleanup option

void NXOpen::PartCleanup::SetCleanupMatingData ( bool cleanupOption )

Sets the option that specifies whether to cleanup mating data.

Created in NX3.0.0.

License requirements : None

Parameters

cleanupOption cleanup option

void NXOpen::PartCleanup::SetCleanupMotionData ( bool cleanupOption )

Sets the option which determines if the motion cleanup option should be performed.

Created in NX12.0.0.

License requirements : None

Parameters

cleanupOption cleanupoption

void NXOpen::PartCleanup::SetCleanupPartFamilyData ( bool cleanupOption )

Sets the option that specifies if the part family data cleanup should be performed.

Created in NX12.0.0.

License requirements : None

Parameters

cleanupOption cleanupoption

void NXOpen::PartCleanup::SetCleanupRoutingData ( bool cleanupOption )

Sets the option which determines if the routing part cleanup option should be performed.

Created in NX7.5.4.

License requirements : None

Parameters

cleanupOption cleanup option

void NXOpen::PartCleanup::SetDeleteBrokenInterpartLinks ( bool cleanupOption )

Sets the option that specifies whether or not to delete all inter-part links where one or more components in that inter-part link have been removed.

Created in NX5.0.0.

License requirements : None

Parameters

cleanupOption cleanup option

void NXOpen::PartCleanup::SetDeleteDuplicateLights ( bool cleanupOption )

Sets the option that specifies whether to delete duplicate light source objects from the part file.

Created in NX7.5.3.

License requirements : None

Parameters

cleanupOption cleanup option

void NXOpen::PartCleanup::SetDeleteInvalidAttributes ( bool cleanupOption )

Sets the option that specifies whether to delete all invalid user attributes from the part file.

Created in NX8.0.3.

License requirements : None

Parameters

cleanupOption cleanup option

void NXOpen::PartCleanup::SetDeleteMaterials ( bool cleanupOption )

Sets the option that specifies whether to delete all materials from the part file.

Created in NX7.5.2.

License requirements : None

Parameters

cleanupOption cleanup option

void NXOpen::PartCleanup::SetDeleteSpreadSheetData ( bool cleanupOption )

Sets the option that specifies whether to delete all spreadsheets from the part file.

Created in NX3.0.0.

License requirements : None

Parameters

cleanupOption cleanup option

void NXOpen::PartCleanup::SetDeleteUnusedExpressions ( bool cleanupOption )

Sets the option that specifies whether to delete expressions that are not used in the part.

Created in NX3.0.0.

License requirements : None

Parameters

cleanupOption cleanup option

void NXOpen::PartCleanup::SetDeleteUnusedExtractReferences ( bool opt )

Sets the option that specifies whether to delete all unused edge/face references in extract features from the part file.

Created in NX11.0.1.

License requirements : None

Parameters

opt opt

void NXOpen::PartCleanup::SetDeleteUnusedFonts ( bool cleanupOption )

Sets the option that specifies whether to remove character fonts that are not used in any drafting text in the current part.

Created in NX3.0.0.

License requirements : None

Parameters

cleanupOption cleanup option

void NXOpen::PartCleanup::SetDeleteUnusedObjects ( bool cleanupOption )

Sets the option that specifies whether to delete all extraneous objects from the work part
Created in NX3.0.0.

License requirements : None

Parameters

cleanupOption cleanup option

void NXOpen::PartCleanup::SetDeleteUnusedUnits ( bool cleanupOption )

Sets the option that specifies whether to remove character fonts that are not used in any drafting text in the current part.

Created in NX12.0.0.

License requirements : None

Parameters

cleanupOption cleanup option

void NXOpen::PartCleanup::SetDeleteVisualEditorData ( bool cleanupOption )

Sets the option that specifies whether to delete Visual Editor data from the part file.

Created in NX3.0.0.

License requirements : None

Parameters

cleanupOption cleanup option

void NXOpen::PartCleanup::SetFixOffplaneSketchCurves ( bool cleanupOption )

Sets the option that specifies whether to fix off-plane sketch curves.

Created in NX3.0.0.

License requirements : None

Parameters

cleanupOption cleanup option

void NXOpen::PartCleanup::SetGroupsToDelete ( NXOpen::PartCleanup::DeleteGroups cleanupOption )

Sets the option that specifies what empty groups should be deleted.

Created in NX3.0.0.

License requirements : None

Parameters

cleanupOption cleanup option

void NXOpen::PartCleanup::SetPartsToCleanup ( NXOpen::PartCleanup::CleanupParts cleanupOption )

Sets the option that specifies what parts will be cleaned up when PartCleanup::DoCleanup is called.

Created in NX3.0.0.

License requirements : None

Parameters

cleanupOption cleanup option

void NXOpen::PartCleanup::SetResetComponentDisplay ( NXOpen::PartCleanup::ResetComponentDisplayAction cleanupOption )

Sets the option that specifies whether to remove assembly-specific geometry in component parts.

Created in NX3.0.0.

License requirements : None

Parameters

cleanupOption cleanup option

void NXOpen::PartCleanup::SetTurnOffHighlighting ( bool cleanupOption )

Sets the option that specifies whether to turn off highlighting for all displayable objects in the displayed part.

Created in NX3.0.0.

License requirements : None

Parameters

cleanupOption cleanup option

bool NXOpen::PartCleanup::TurnOffHighlighting ( )

Returns the option that specifies whether to turn off highlighting for all displayable objects in the displayed part.

Created in NX3.0.0.

License requirements : None

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

PartCleanup.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation