nxopen

Interface PartCleanup

All Superinterfaces:

Remote, TransientObject

public interface PartCleanup
extends TransientObject

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PartCleanup.CleanupParts Which parts to clean up
static class	PartCleanup.DeleteGroups Which empty groups to clean up
static class	PartCleanup.ResetComponentDisplayAction Assembly display clean up action

Method Summary

Modifier and Type	Method and Description
boolean	cleanupAssemblyConstraints() Returns the option that specifies whether to cleanup assembly constraints.
boolean	cleanupCAMObjects() Returns the option that specifies whether to delete or fix any corrupt internal CAM objects.
boolean	cleanupDraftingObjects() Returns the option that specifies whether to perform drafting cleanup.
boolean	cleanupFeatureData() Returns the option that specifies whether to perform solid cleanup.
boolean	cleanupMatingData() Returns the option that specifies whether to cleanup mating data.
boolean	cleanupRoutingData() Returns the option which determines if the routing part cleanup option should be performed.
boolean	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.
boolean	deleteDuplicateLights() Returns the option that specifies whether to delete duplicate light source objects from the part file.
boolean	deleteInvalidAttributes() Returns the option that specifies whether to delete all invalid user attributes from the part file.
boolean	deleteMaterials() Returns the option that specifies whether to delete all materials from the part file.
boolean	deleteSpreadSheetData() Returns the option that specifies whether to delete all spreadsheets from the part file.
boolean	deleteUnusedExpressions() Returns the option that specifies whether to delete expressions that are not used in the part.
boolean	deleteUnusedFonts() Returns the option that specifies whether to remove character fonts that are not used in any drafting text in the current part.
boolean	deleteUnusedObjects() Returns the option that specifies whether to delete all extraneous objects from the work part License requirements: None.
boolean	deleteVisualEditorData() Returns the option that specifies whether to delete Visual Editor data from the part file.
void	doCleanup() Actually performs the part cleanup operation according to the properties set on this object License requirements: None.
boolean	fixOffplaneSketchCurves() Returns the option that specifies whether to fix off-plane sketch curves.
PartCleanup.DeleteGroups	groupsToDelete() Returns the option that specifies what empty groups should be deleted.
PartCleanup.CleanupParts	partsToCleanup() Returns the option that specifies what parts will be cleaned up when doCleanup() is called.
void	reset() Resets all the properties back to the default values (i.e. everything turned off).
PartCleanup.ResetComponentDisplayAction	resetComponentDisplay() Returns the option that specifies whether to remove assembly-specific geometry in component parts.
void	setCleanupAssemblyConstraints(boolean option) Sets the option that specifies whether to cleanup assembly constraints.
void	setCleanupCAMObjects(boolean option) Sets the option that specifies whether to delete or fix any corrupt internal CAM objects.
void	setCleanupDraftingObjects(boolean option) Sets the option that specifies whether to perform drafting cleanup.
void	setCleanupFeatureData(boolean option) Sets the option that specifies whether to perform solid cleanup.
void	setCleanupMatingData(boolean option) Sets the option that specifies whether to cleanup mating data.
void	setCleanupRoutingData(boolean option) Sets the option which determines if the routing part cleanup option should be performed.
void	setDeleteBrokenInterpartLinks(boolean option) 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.
void	setDeleteDuplicateLights(boolean option) Sets the option that specifies whether to delete duplicate light source objects from the part file.
void	setDeleteInvalidAttributes(boolean option) Sets the option that specifies whether to delete all invalid user attributes from the part file.
void	setDeleteMaterials(boolean option) Sets the option that specifies whether to delete all materials from the part file.
void	setDeleteSpreadSheetData(boolean option) Sets the option that specifies whether to delete all spreadsheets from the part file.
void	setDeleteUnusedExpressions(boolean option) Sets the option that specifies whether to delete expressions that are not used in the part.
void	setDeleteUnusedFonts(boolean option) Sets the option that specifies whether to remove character fonts that are not used in any drafting text in the current part.
void	setDeleteUnusedObjects(boolean option) Sets the option that specifies whether to delete all extraneous objects from the work part License requirements: None.
void	setDeleteVisualEditorData(boolean option) Sets the option that specifies whether to delete Visual Editor data from the part file.
void	setFixOffplaneSketchCurves(boolean option) Sets the option that specifies whether to fix off-plane sketch curves.
void	setGroupsToDelete(PartCleanup.DeleteGroups option) Sets the option that specifies what empty groups should be deleted.
void	setPartsToCleanup(PartCleanup.CleanupParts option) Sets the option that specifies what parts will be cleaned up when doCleanup() is called.
void	setResetComponentDisplay(PartCleanup.ResetComponentDisplayAction option) Sets the option that specifies whether to remove assembly-specific geometry in component parts.
void	setTurnOffHighlighting(boolean option) Sets the option that specifies whether to turn off highlighting for all displayable objects in the displayed part.
boolean	turnOffHighlighting() Returns the option that specifies whether to turn off highlighting for all displayable objects in the displayed part.

Methods inherited from interface nxopen.TransientObject

_value, dispose, printTestData, printTestData

Method Detail

setPartsToCleanup

void setPartsToCleanup(PartCleanup.CleanupParts option)
                throws NXException,
                       RemoteException

Sets the option that specifies what parts will be cleaned up when doCleanup() is called.
License requirements: None.

Created in NX3.0.0

Parameters:

option -

Throws:

NXException

RemoteException

partsToCleanup

PartCleanup.CleanupParts partsToCleanup()
                                 throws NXException,
                                        RemoteException

Returns the option that specifies what parts will be cleaned up when doCleanup() is called.
License requirements: None.

Created in NX3.0.0

Throws:

NXException

RemoteException

setGroupsToDelete

void setGroupsToDelete(PartCleanup.DeleteGroups option)
                throws NXException,
                       RemoteException

Sets the option that specifies what empty groups should be deleted.
License requirements: None.

Created in NX3.0.0

Parameters:

option -

Throws:

NXException

RemoteException

groupsToDelete

PartCleanup.DeleteGroups groupsToDelete()
                                 throws NXException,
                                        RemoteException

Returns the option that specifies what empty groups should be deleted.
License requirements: None.

Created in NX3.0.0

Throws:

NXException

RemoteException

setTurnOffHighlighting

void setTurnOffHighlighting(boolean option)
                     throws NXException,
                            RemoteException

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

Created in NX3.0.0

Parameters:

option -

Throws:

NXException

RemoteException

turnOffHighlighting

boolean turnOffHighlighting()
                     throws NXException,
                            RemoteException

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

Created in NX3.0.0

Throws:

NXException

RemoteException

setDeleteUnusedObjects

void setDeleteUnusedObjects(boolean option)
                     throws NXException,
                            RemoteException

Sets the option that specifies whether to delete all extraneous objects from the work part
License requirements: None.

Created in NX3.0.0

Parameters:

option -

Throws:

NXException

RemoteException

deleteUnusedObjects

boolean deleteUnusedObjects()
                     throws NXException,
                            RemoteException

Returns the option that specifies whether to delete all extraneous objects from the work part
License requirements: None.

Created in NX3.0.0

Throws:

NXException

RemoteException

setDeleteUnusedExpressions

void setDeleteUnusedExpressions(boolean option)
                         throws NXException,
                                RemoteException

Sets the option that specifies whether to delete expressions that are not used in the part.
License requirements: None.

Created in NX3.0.0

Parameters:

option -

Throws:

NXException

RemoteException

deleteUnusedExpressions

boolean deleteUnusedExpressions()
                         throws NXException,
                                RemoteException

Returns the option that specifies whether to delete expressions that are not used in the part.
License requirements: None.

Created in NX3.0.0

Throws:

NXException

RemoteException

setCleanupFeatureData

void setCleanupFeatureData(boolean option)
                    throws NXException,
                           RemoteException

Sets the option that specifies whether to perform solid cleanup.
License requirements: None.

Created in NX3.0.0

Parameters:

option -

Throws:

NXException

RemoteException

cleanupFeatureData

boolean cleanupFeatureData()
                    throws NXException,
                           RemoteException

Returns the option that specifies whether to perform solid cleanup.
License requirements: None.

Created in NX3.0.0

Throws:

NXException

RemoteException

setFixOffplaneSketchCurves

void setFixOffplaneSketchCurves(boolean option)
                         throws NXException,
                                RemoteException

Sets the option that specifies whether to fix off-plane sketch curves.
License requirements: None.

Created in NX3.0.0

Parameters:

option -

Throws:

NXException

RemoteException

fixOffplaneSketchCurves

boolean fixOffplaneSketchCurves()
                         throws NXException,
                                RemoteException

Returns the option that specifies whether to fix off-plane sketch curves.
License requirements: None.

Created in NX3.0.0

Throws:

NXException

RemoteException

setCleanupMatingData

void setCleanupMatingData(boolean option)
                   throws NXException,
                          RemoteException

Sets the option that specifies whether to cleanup mating data.
License requirements: None.

Created in NX3.0.0

Parameters:

option -

Throws:

NXException

RemoteException

cleanupMatingData

boolean cleanupMatingData()
                   throws NXException,
                          RemoteException

Returns the option that specifies whether to cleanup mating data.
License requirements: None.

Created in NX3.0.0

Throws:

NXException

RemoteException

setCleanupAssemblyConstraints

void setCleanupAssemblyConstraints(boolean option)
                            throws NXException,
                                   RemoteException

Sets the option that specifies whether to cleanup assembly constraints.
License requirements: None.

Created in NX7.5.5

Parameters:

option -

Throws:

NXException

RemoteException

cleanupAssemblyConstraints

boolean cleanupAssemblyConstraints()
                            throws NXException,
                                   RemoteException

Returns the option that specifies whether to cleanup assembly constraints.
License requirements: None.

Created in NX7.5.5

Throws:

NXException

RemoteException

setCleanupCAMObjects

void setCleanupCAMObjects(boolean option)
                   throws NXException,
                          RemoteException

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

Created in NX3.0.0

Parameters:

option -

Throws:

NXException

RemoteException

cleanupCAMObjects

boolean cleanupCAMObjects()
                   throws NXException,
                          RemoteException

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

Created in NX3.0.0

Throws:

NXException

RemoteException

setCleanupDraftingObjects

void setCleanupDraftingObjects(boolean option)
                        throws NXException,
                               RemoteException

Sets the option that specifies whether to perform drafting cleanup.
License requirements: None.

Created in NX3.0.0

Parameters:

option -

Throws:

NXException

RemoteException

cleanupDraftingObjects

boolean cleanupDraftingObjects()
                        throws NXException,
                               RemoteException

Returns the option that specifies whether to perform drafting cleanup.
License requirements: None.

Created in NX3.0.0

Throws:

NXException

RemoteException

setDeleteUnusedFonts

void setDeleteUnusedFonts(boolean option)
                   throws NXException,
                          RemoteException

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

Created in NX3.0.0

Parameters:

option -

Throws:

NXException

RemoteException

deleteUnusedFonts

boolean deleteUnusedFonts()
                   throws NXException,
                          RemoteException

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

Created in NX3.0.0

Throws:

NXException

RemoteException

setResetComponentDisplay

void setResetComponentDisplay(PartCleanup.ResetComponentDisplayAction option)
                       throws NXException,
                              RemoteException

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

Created in NX3.0.0

Parameters:

option -

Throws:

NXException

RemoteException

resetComponentDisplay

PartCleanup.ResetComponentDisplayAction resetComponentDisplay()
                                                       throws NXException,
                                                              RemoteException

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

Created in NX3.0.0

Throws:

NXException

RemoteException

setDeleteSpreadSheetData

void setDeleteSpreadSheetData(boolean option)
                       throws NXException,
                              RemoteException

Sets the option that specifies whether to delete all spreadsheets from the part file.
License requirements: None.

Created in NX3.0.0

Parameters:

option -

Throws:

NXException

RemoteException

deleteSpreadSheetData

boolean deleteSpreadSheetData()
                       throws NXException,
                              RemoteException

Returns the option that specifies whether to delete all spreadsheets from the part file.
License requirements: None.

Created in NX3.0.0

Throws:

NXException

RemoteException

setDeleteVisualEditorData

void setDeleteVisualEditorData(boolean option)
                        throws NXException,
                               RemoteException

Sets the option that specifies whether to delete Visual Editor data from the part file.
License requirements: None.

Created in NX3.0.0

Parameters:

option -

Throws:

NXException

RemoteException

deleteVisualEditorData

boolean deleteVisualEditorData()
                        throws NXException,
                               RemoteException

Returns the option that specifies whether to delete Visual Editor data from the part file.
License requirements: None.

Created in NX3.0.0

Throws:

NXException

RemoteException

setDeleteMaterials

void setDeleteMaterials(boolean option)
                 throws NXException,
                        RemoteException

Sets the option that specifies whether to delete all materials from the part file.
License requirements: None.

Created in NX7.5.2

Parameters:

option -

Throws:

NXException

RemoteException

deleteMaterials

boolean deleteMaterials()
                 throws NXException,
                        RemoteException

Returns the option that specifies whether to delete all materials from the part file.
License requirements: None.

Created in NX7.5.2

Throws:

NXException

RemoteException

setDeleteDuplicateLights

void setDeleteDuplicateLights(boolean option)
                       throws NXException,
                              RemoteException

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

Created in NX7.5.3

Parameters:

option -

Throws:

NXException

RemoteException

deleteDuplicateLights

boolean deleteDuplicateLights()
                       throws NXException,
                              RemoteException

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

Created in NX7.5.3

Throws:

NXException

RemoteException

setDeleteBrokenInterpartLinks

void setDeleteBrokenInterpartLinks(boolean option)
                            throws NXException,
                                   RemoteException

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.
License requirements: None.

Created in NX5.0.0

Parameters:

option -

Throws:

NXException

RemoteException

deleteBrokenInterpartLinks

boolean deleteBrokenInterpartLinks()
                            throws NXException,
                                   RemoteException

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.
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

doCleanup

void doCleanup()
        throws NXException,
               RemoteException

Actually performs the part cleanup operation according to the properties set on this object
License requirements: None.

Created in NX3.0.0

Throws:

NXException

RemoteException

reset

void reset()
    throws NXException,
           RemoteException

Resets all the properties back to the default values (i.e. everything turned off).
License requirements: None.

Created in NX3.0.0

Throws:

NXException

RemoteException

setCleanupRoutingData

void setCleanupRoutingData(boolean option)
                    throws NXException,
                           RemoteException

Sets the option which determines if the routing part cleanup option should be performed.
License requirements: None.

Created in NX7.5.4

Parameters:

option -

Throws:

NXException

RemoteException

cleanupRoutingData

boolean cleanupRoutingData()
                    throws NXException,
                           RemoteException

Returns the option which determines if the routing part cleanup option should be performed.
License requirements: None.

Created in NX7.5.4

Throws:

NXException

RemoteException

setDeleteInvalidAttributes

void setDeleteInvalidAttributes(boolean option)
                         throws NXException,
                                RemoteException

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

Created in NX8.0.3

Parameters:

option -

Throws:

NXException

RemoteException

deleteInvalidAttributes

boolean deleteInvalidAttributes()
                         throws NXException,
                                RemoteException

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

Created in NX8.0.3

Throws:

NXException

RemoteException