Represents the collection of all parts in a session. More...

Inheritance diagram for NXOpen::PartCollection:

Classes
class	iterator
	Iterator for accessing the contents of the collection. More...

Public Types
typedef NXOpen::Callback1 < void, NXOpen::BasePart * >	PartClosedHandler
	User defined method that is called whenever a part is in the process of being closed. More...

typedef NXOpen::Callback1 < void, NXOpen::BasePart * >	PartCreatedHandler
	User defined method that is called whenever a new part is created. More...

typedef NXOpen::Callback1 < void, NXOpen::BasePart * >	PartModifiedHandler
	User defined method that is called whenever a part is modified Created in NX6.0.0. More...

typedef NXOpen::Callback1 < void, NXOpen::BasePart * >	PartOpenedHandler
	User defined method that is called whenever a part is opened. More...

typedef NXOpen::Callback1 < void, NXOpen::BasePart * >	PartRenamedHandler
	User defined method that is called whenever a part is renamed Created in NX6.0.0. More...

typedef NXOpen::Callback1 < void, NXOpen::BasePart * >	PartSavedAsHandler
	User defined method that is called whenever a part is saved as a specified name. More...

typedef NXOpen::Callback1 < void, NXOpen::BasePart * >	PartSavedHandler
	User defined method that is called whenever a part is saved.Do not create, open, save other parts or change display part inside this callback. More...

enum	RefsetOption { RefsetOptionEntire, RefsetOptionCurrent, RefsetOptionPreserveRefset }
	Controls the reference set used when setting the work component. More...

enum	SdpsStatus { SdpsStatusOk, SdpsStatusOutsideModelling, SdpsStatusDrawingDisplayed, SdpsStatusInPartsList, SdpsStatusGdt, SdpsStatusUnitsMismatch }
	Indicates the reason why it was not possible to use Design in Context (i.e. More...

enum	WorkComponentOption { WorkComponentOptionVisible, WorkComponentOptionGiven }
	Controls the behavior when setting the work component. More...

typedef NXOpen::Callback1 < void, NXOpen::BasePart * >	WorkPartChangedHandler
	User defined method that is called whenever the work part changes Created in NX6.0.0. More...

Public Member Functions
int	AddPartClosedHandler (const NXOpen::PartCollection::PartClosedHandler &handler)
	Registers a user defined method that is called whenever a part is in the process of being closed. More...

int	AddPartCreatedHandler (const NXOpen::PartCollection::PartCreatedHandler &handler)
	Registers a user defined method that is called whenever a new part is created. More...

int	AddPartModifiedHandler (const NXOpen::PartCollection::PartModifiedHandler &handler)
	Registers a user defined method that is called whenever a part is modified. More...

int	AddPartOpenedHandler (const NXOpen::PartCollection::PartOpenedHandler &handler)
	Registers a user defined method that is called whenever a part is opened. More...

int	AddPartRenamedHandler (const NXOpen::PartCollection::PartRenamedHandler &handler)
	Registers a user defined method that is called whenever a part is renamed. More...

int	AddPartSavedAsHandler (const NXOpen::PartCollection::PartSavedAsHandler &handler)
	Registers a user defined method that is called whenever a part is saved as a specified name. More...

int	AddPartSavedHandler (const NXOpen::PartCollection::PartSavedHandler &handler)
	Registers a user defined method that is called whenever a part is saved. More...

int	AddWorkPartChangedHandler (const NXOpen::PartCollection::WorkPartChangedHandler &handler)
	Registers a method that is called whenever the work part changes. More...

NXOpen::BasePart *	BaseDisplay ()
	Returns the current display part of the session. More...

NXOpen::BasePart *	BaseWork ()
	Returns the current work part of the session. More...

iterator	begin ()
	Returns an iterator addressing the first element. More...

void	CloseAll (NXOpen::BasePart::CloseModified closeModified, NXOpen::PartCloseResponses *responses)
	Closes all the parts open in the session. More...

NXOpen::LinkedMirrorPartBuilder *	CreateLinkedMirrorPartBuilder (NXOpen::Part *part)
	Creates a NXOpen::LinkedMirrorPartBuilder. More...

NXOpen::Part *	Display ()
	Returns the current display part of the session. More...

iterator	end ()
	Returns an iterator addressing one past the last element. More...

NXOpen::FileNew *	FileNew ()
	Creates a NXOpen::FileNew. More...

NXOpen::BasePart *	FindObject (const NXString &name)
	Finds the NXOpen::BasePart with the given name. More...

NXOpen::BasePart *	FindObject (const char *name)
	Finds the NXOpen::BasePart with the given name. More...

NXOpen::PartSaveStatus *	ForceSaveAll ()
	Saves all modified parts in a session. More...

NXOpen::LinkedMirrorPartBuilder::MirrorCsysOption	GetMirrorCsysOptionOfMirrorPart (NXOpen::Part *part)
	Get the type of mirror coordinate system for the given linked mirrored part. More...

NXOpen::LinkedMirrorPartBuilder::MirrorPartTypeOption	GetMirrorPartType (NXOpen::Part *part)
	Get the type of linked mirrored part. More...

void	GetMirrorPlaneDataOfMirrorPart (NXOpen::Part part, NXOpen::Point3d mirrorPlaneOrigin, NXOpen::Vector3d *mirrorPlaneDirection)
	Get the origin point and the normal direction of the mirror plane for the given linked mirrored part Created in NX8.5.1. More...

NXString	GetSourcePartNameOfMirrorPart (NXOpen::Part *mirrorPart)
	Get source part name of mirror part. More...

NXOpen::Part *	ImportToolDesignPackage (const NXString &filename, const NXString &outputDirectory, NXOpen::PartLoadStatus loadStatus, NXOpen::PartSaveStatus saveStatus)
	Import tool design package. More...

NXOpen::Part *	ImportToolDesignPackage (const char filename, const char outputDirectory, NXOpen::PartLoadStatus loadStatus, NXOpen::PartSaveStatus saveStatus)
	Import tool design package. More...

bool	IsExactMirroredPart (NXOpen::Part *part)
	Check whether given part is an exact linked mirrored part. More...

bool	IsMirroredPart (NXOpen::Part *part)
	Check whether given part is a linked mirrored part. More...

NXOpen::LoadOptions *	LoadOptions ()
	The NXOpen::LoadOptions that determines how parts are loaded in this session Created in NX3.0.0. More...

NXOpen::BasePart *	NewBaseDisplay (const NXString &name, NXOpen::BasePart::Units units)
	Creates a new part and sets this part as the display part. More...

NXOpen::BasePart *	NewBaseDisplay (const char *name, NXOpen::BasePart::Units units)
	Creates a new part and sets this part as the display part. More...

NXOpen::Part *	NewDisplay (const NXString &name, NXOpen::Part::Units units)
	Creates a new .prt part and sets this part as the display part. More...

NXOpen::Part *	NewDisplay (const char *name, NXOpen::Part::Units units)
	Creates a new .prt part and sets this part as the display part. More...

NXOpen::PartCloseResponses *	NewPartCloseResponses ()
	Constructs a new PartCloseResponses class. More...

NXOpen::Part *	Open (const NXString &filename, NXOpen::PartLoadStatus **loadStatus)
	Opens an existing .prt part, but does not set it to be the displayed part. More...

NXOpen::Part *	Open (const char filename, NXOpen::PartLoadStatus *loadStatus)
	Opens an existing .prt part, but does not set it to be the displayed part. More...

NXOpen::BasePart *	OpenBase (const NXString &filename, NXOpen::PartLoadStatus **loadStatus)
	Opens an existing part, but does not set it to be the displayed part. More...

NXOpen::BasePart *	OpenBase (const char filename, NXOpen::PartLoadStatus *loadStatus)
	Opens an existing part, but does not set it to be the displayed part. More...

NXOpen::BasePart *	OpenBaseDisplay (const NXString &filename, NXOpen::PartLoadStatus **loadStatus)
	Opens an existing part and sets this part as the display part. More...

NXOpen::BasePart *	OpenBaseDisplay (const char filename, NXOpen::PartLoadStatus *loadStatus)
	Opens an existing part and sets this part as the display part. More...

NXOpen::Part *	OpenDisplay (const NXString &filename, NXOpen::PartLoadStatus **loadStatus)
	Opens an existing .prt part and sets this part as the display part. More...

NXOpen::Part *	OpenDisplay (const char filename, NXOpen::PartLoadStatus *loadStatus)
	Opens an existing .prt part and sets this part as the display part. More...

void	OpenSeedPartBlankTemplate (const NXString &filename, bool addMaster)
	Open unpopulated dataset with blank template Created in NX6.0.0. More...

void	OpenSeedPartBlankTemplate (const char *filename, bool addMaster)
	Open unpopulated dataset with blank template Created in NX6.0.0. More...

NXOpen::PDM::PartManager *	PDMPartManager ()
	The NXOpen::PDM::PartManager that manages creation of parts in NX Manager mode Created in NX3.0.0. More...

void	RemovePartClosedHandler (int id)
	Unregisters a user defined method that is called whenever a part is in the process of being closed Created in NX6.0.0. More...

void	RemovePartCreatedHandler (int id)
	Unregisters a user defined method that is called whenever a new part is created Created in NX6.0.0. More...

void	RemovePartModifiedHandler (int id)
	Unregisters a user defined method that is called whenever a part is modified Created in NX6.0.0. More...

void	RemovePartOpenedHandler (int id)
	Unregisters a user defined method that is called whenever a part is opened Created in NX6.0.0. More...

void	RemovePartRenamedHandler (int id)
	Unregisters a user defined method that is called whenever a part is renamed Created in NX6.0.0. More...

void	RemovePartSavedAsHandler (int id)
	Unregisters a user defined method that is called whenever a part is saved as a specified name Created in NX6.0.0. More...

void	RemovePartSavedHandler (int id)
	Unregisters a user defined method that is called whenever a part is saved Created in NX6.0.0. More...

void	RemovePassword (NXOpen::Part *part)
	Remove password of the part. More...

void	RemoveWorkPartChangedHandler (int id)
	Unregisters a method that is called whenever the work part changes. More...

NXOpen::PartReopenReport *	ReopenAll (NXOpen::BasePart::CloseModified closeModified, NXOpen::PartCloseResponses *responses)
	Reopens all modified parts in the session. More...

void	SaveAll (bool anyPartsModified, NXOpen::PartSaveStatus *saveStatus)
	Saves all modified parts in a session. More...

NXOpen::SaveOptions *	SaveOptions ()
	The NXOpen::SaveOptions that determines how parts are saved in this session Created in NX3.0.0. More...

NXOpen::PartCollection::SdpsStatus	SetDisplay (NXOpen::BasePart part, bool maintainWorkPart, bool setEntirePart, NXOpen::PartLoadStatus *loadStatus)
	Sets the displayed part. More...

void	SetMirrorPartType (NXOpen::Part *part, NXOpen::LinkedMirrorPartBuilder::MirrorPartTypeOption mirrorOption)
	Set the type of linked mirrored part Created in NX8.5.0. More...

void	SetNonmasterSeedPartData (const NXString &filename)
	Set non master seed part data for opening unpopulated non master part Created in NX6.0.0. More...

void	SetNonmasterSeedPartData (const char *filename)
	Set non master seed part data for opening unpopulated non master part Created in NX6.0.0. More...

void	SetOpenPassword (const NXString &fileName, const NXString &password)
	Input password to the current session. More...

void	SetOpenPassword (const char fileName, const char password)
	Input password to the current session. More...

void	SetPassword (NXOpen::Part *part, const NXString &uAdminPassword, const NXString &uReadPassword, const NXString &uWritePassword, const NXString &uFullControlPassword)
	Set password to the part. More...

void	SetPassword (NXOpen::Part part, const char uAdminPassword, const char uReadPassword, const char uWritePassword, const char *uFullControlPassword)
	Set password to the part. More...

void	SetSeedPartTemplateData (const NXString &filename, const NXString &templateName, bool addMaster)
	Specify template data to open seed part or empty item revision Created in NX6.0.0. More...

void	SetSeedPartTemplateData (const char filename, const char templateName, bool addMaster)
	Specify template data to open seed part or empty item revision Created in NX6.0.0. More...

void	SetWork (NXOpen::BasePart *part)
	Sets the current work part. More...

void	SetWorkComponent (NXOpen::Assemblies::Component workComponent, NXOpen::PartLoadStatus *loadStatus)
	Sets the work component. More...

void	SetWorkComponent (NXOpen::Assemblies::Component workComponent, NXOpen::PartCollection::RefsetOption refsetOption, NXOpen::PartCollection::WorkComponentOption visibility, NXOpen::PartLoadStatus *loadStatus)
	Sets the work component. More...

NXOpen::PartLoadStatus *	SetWorkComponentOverride (NXOpen::Assemblies::Component *workComponent)
	Sets the component with override part as the work component. More...

NXOpen::ShapeSearch::SearchManager *	ShapeSearchManager ()
	The NXOpen::ShapeSearch::SearchManager that manages shape search in this session Created in NX6.0.0. More...

void	SolveAllPostponedConstraints ()
	Solves all the constraints, that have been postponed in their arrangement, in every loaded part in the session. More...

tag_t	Tag () const
	Returns the tag of this object. More...

NXOpen::Part *	Work ()
	Returns the current work part of the session. More...

NXOpen::Assemblies::Component *	WorkComponent ()
	Returns the work component. More...

Detailed Description

Represents the collection of all parts in a session.

Several methods including NXOpen::PartCollection::NewDisplay , NXOpen::PartCollection::OpenDisplay and NXOpen::BasePart::SaveAs can take part names in NX Manager command-line format while running in NX Manager mode. This format is as follows:

Master Part:        \<@\>DB/part-number/revision
                    \<@\>DB/part-number/revision/master
                    \<@\>DB/part-number/revision/master
                    \<@\>DB/part-number/revision/master/version
Non-Master Part:    \<@\>DB/part-number/revision/type/name
                    \<@\>DB/part-number/revision/type/name/version

The separator character ('/') may be any character not used in the part-number, revision or type fields. It is inferred as the first character after the "\<@\>DB" prefix.

To obtain an instance of this class, refer to NXOpen::Session

Created in NX3.0.0.

Member Typedef Documentation

typedef NXOpen::Callback1<void, NXOpen::BasePart *> NXOpen::PartCollection::PartClosedHandler

User defined method that is called whenever a part is in the process of being closed.

Do not create, open, save other parts or change display part inside this callback.
Created in NX6.0.0.

License requirements : None

typedef NXOpen::Callback1<void, NXOpen::BasePart *> NXOpen::PartCollection::PartCreatedHandler

User defined method that is called whenever a new part is created.

Do not create, open, save other parts or change display part inside this callback.
Created in NX6.0.0.

License requirements : None

typedef NXOpen::Callback1<void, NXOpen::BasePart *> NXOpen::PartCollection::PartModifiedHandler

User defined method that is called whenever a part is modified
Created in NX6.0.0.

License requirements : None

typedef NXOpen::Callback1<void, NXOpen::BasePart *> NXOpen::PartCollection::PartOpenedHandler

User defined method that is called whenever a part is opened.

Do not create, open, save other parts or change display part inside this callback.
Created in NX6.0.0.

License requirements : None

typedef NXOpen::Callback1<void, NXOpen::BasePart *> NXOpen::PartCollection::PartRenamedHandler

User defined method that is called whenever a part is renamed
Created in NX6.0.0.

License requirements : None

typedef NXOpen::Callback1<void, NXOpen::BasePart *> NXOpen::PartCollection::PartSavedAsHandler

User defined method that is called whenever a part is saved as a specified name.

Do not create, open, save other parts or change display part inside this callback.
Created in NX6.0.0.

License requirements : None

typedef NXOpen::Callback1<void, NXOpen::BasePart *> NXOpen::PartCollection::PartSavedHandler

User defined method that is called whenever a part is saved.Do not create, open, save other parts or change display part inside this callback.

Created in NX6.0.0.

License requirements : None

typedef NXOpen::Callback1<void, NXOpen::BasePart *> NXOpen::PartCollection::WorkPartChangedHandler

User defined method that is called whenever the work part changes
Created in NX6.0.0.

License requirements : None

Member Enumeration Documentation

enum NXOpen::PartCollection::RefsetOption

Controls the reference set used when setting the work component.

See SetWorkComponent

Enumerator
RefsetOptionEntire	Use the "Entire Part" reference set for the new work component.
RefsetOptionCurrent	Use the component's current reference set.
RefsetOptionPreserveRefset	Do not change the value of the reference set.

enum NXOpen::PartCollection::SdpsStatus

Indicates the reason why it was not possible to use Design in Context (i.e.

to set the work part to a component of the displayed part.)

Used as a return code for NXOpen::PartCollection::SetDisplay

Enumerator
SdpsStatusOk	The work part was set successfully. This code indicates success: all other codes indicate failure
SdpsStatusOutsideModelling	The modelling application is not active.
SdpsStatusDrawingDisplayed	A drawing is currently displayed.
SdpsStatusInPartsList	The Part List module is active.
SdpsStatusGdt	The Tolerancing module is active.
SdpsStatusUnitsMismatch	The work part and displayed part have different units.

enum NXOpen::PartCollection::WorkComponentOption

Controls the behavior when setting the work component.

See SetWorkComponent

Enumerator

WorkComponentOptionVisible

If the given work component is not visible, chose another component that represents the same part.

If no suitable visible component can be found, throw an exception. This option ensures that the new work component will always be visible.

WorkComponentOptionGiven

Use the given work component, regardless of visibility.

Member Function Documentation

int NXOpen::PartCollection::AddPartClosedHandler ( const NXOpen::PartCollection::PartClosedHandler & handler )

Registers a user defined method that is called whenever a part is in the process of being closed.

Returns: identifier of registered method (used to unregister the method)
Created in NX6.0.0.

License requirements : None

Parameters

handler method to register

int NXOpen::PartCollection::AddPartCreatedHandler ( const NXOpen::PartCollection::PartCreatedHandler & handler )

Registers a user defined method that is called whenever a new part is created.

Returns: identifier of registered method (used to unregister the method)
Created in NX6.0.0.

License requirements : None

Parameters

handler method to register

int NXOpen::PartCollection::AddPartModifiedHandler ( const NXOpen::PartCollection::PartModifiedHandler & handler )

Registers a user defined method that is called whenever a part is modified.

Returns: identifier of registered method (used to unregister the method)
Created in NX6.0.0.

License requirements : None

Parameters

handler method to register

int NXOpen::PartCollection::AddPartOpenedHandler ( const NXOpen::PartCollection::PartOpenedHandler & handler )

Registers a user defined method that is called whenever a part is opened.

Returns: identifier of registered method (used to unregister the method)
Created in NX6.0.0.

License requirements : None

Parameters

handler method to register

int NXOpen::PartCollection::AddPartRenamedHandler ( const NXOpen::PartCollection::PartRenamedHandler & handler )

Registers a user defined method that is called whenever a part is renamed.

Returns: identifier of registered method (used to unregister the method)
Created in NX6.0.0.

License requirements : None

Parameters

handler method to register

int NXOpen::PartCollection::AddPartSavedAsHandler ( const NXOpen::PartCollection::PartSavedAsHandler & handler )

Registers a user defined method that is called whenever a part is saved as a specified name.

Returns: identifier of registered method (used to unregister the method)
Created in NX6.0.0.

License requirements : None

Parameters

handler method to register

int NXOpen::PartCollection::AddPartSavedHandler ( const NXOpen::PartCollection::PartSavedHandler & handler )

Registers a user defined method that is called whenever a part is saved.

Returns: identifier of registered method (used to unregister the method)
Created in NX6.0.0.

License requirements : None

Parameters

handler method to register

int NXOpen::PartCollection::AddWorkPartChangedHandler ( const NXOpen::PartCollection::WorkPartChangedHandler & handler )

Registers a method that is called whenever the work part changes.

Returns: identifier of registered method (used to unregister the method)
Created in NX6.0.0.

License requirements : None

Parameters

handler method to register

NXOpen::BasePart* NXOpen::PartCollection::BaseDisplay ( )

Returns the current display part of the session.

Created in NX4.0.0.

License requirements : None

NXOpen::BasePart* NXOpen::PartCollection::BaseWork ( )

Returns the current work part of the session.

This is either the displayed part, or a part represented by a component in the displayed part's NXOpen::Assemblies::ComponentAssembly . See: NXOpen::PartCollection::WorkComponent

Created in NX4.0.0.

License requirements : None

iterator NXOpen::PartCollection::begin ( )

Returns an iterator addressing the first element.

void NXOpen::PartCollection::CloseAll	(	NXOpen::BasePart::CloseModified	closeModified,
		NXOpen::PartCloseResponses *	responses
	)

Closes all the parts open in the session.

Created in NX3.0.0.

License requirements : None

Parameters

closeModified	Behavior of close if component parts are modified.
responses	Class representing list of parts to close or leave open if modified. Only used if closed_modified is set to NXOpen::BasePart::CloseModifiedUseResponses . If NXOpen::BasePart::CloseModifiedUseResponses is set, then any parts that are candidates for being closed that are not in this list will be closed whether modified or not. See NXOpen::PartCloseResponses for how to add responses to this class.

NXOpen::LinkedMirrorPartBuilder* NXOpen::PartCollection::CreateLinkedMirrorPartBuilder ( NXOpen::Part * part )

Creates a NXOpen::LinkedMirrorPartBuilder.

Returns: the LinkedMirrorPartBuilder object
Created in NX8.5.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

part part

NXOpen::Part* NXOpen::PartCollection::Display ( )

Returns the current display part of the session.

An error will be thrown if the display part is not a .prt part.
Created in NX3.0.0.

License requirements : None

iterator NXOpen::PartCollection::end ( )

Returns an iterator addressing one past the last element.

NXOpen::FileNew* NXOpen::PartCollection::FileNew ( )

Creates a NXOpen::FileNew.

Returns: Created in NX5.0.0.

License requirements : None

NXOpen::BasePart* NXOpen::PartCollection::FindObject ( const NXString & name )

Finds the NXOpen::BasePart with the given name.

The part must have been loaded in this session.

An exception will be thrown if no object can be found with the given name.

Returns: The part with the given name.
Created in NX3.0.0.

License requirements : None

Parameters

name	The name of the NXOpen::BasePart . This may either be the full pathname of the leaf name.

NXOpen::BasePart* NXOpen::PartCollection::FindObject ( const char * name )

Finds the NXOpen::BasePart with the given name.

The part must have been loaded in this session.

An exception will be thrown if no object can be found with the given name.

Returns: The part with the given name.
Created in NX3.0.0.

License requirements : None

Parameters

name	The name of the NXOpen::BasePart . This may either be the full pathname of the leaf name.

NXOpen::PartSaveStatus* NXOpen::PartCollection::ForceSaveAll ( )

Saves all modified parts in a session.

Returns: Parts that could not be saved and their associated errors.
Created in NX6.0.0.

License requirements : None

NXOpen::LinkedMirrorPartBuilder::MirrorCsysOption NXOpen::PartCollection::GetMirrorCsysOptionOfMirrorPart ( NXOpen::Part * part )

Get the type of mirror coordinate system for the given linked mirrored part.

Returns: Created in NX8.5.1.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

part	input linked mirror part. Error is raised if input is not a linked mirror part

NXOpen::LinkedMirrorPartBuilder::MirrorPartTypeOption NXOpen::PartCollection::GetMirrorPartType ( NXOpen::Part * part )

Get the type of linked mirrored part.

Returns: Created in NX8.5.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

part	input part

void NXOpen::PartCollection::GetMirrorPlaneDataOfMirrorPart	(	NXOpen::Part *	part,
		NXOpen::Point3d *	mirrorPlaneOrigin,
		NXOpen::Vector3d *	mirrorPlaneDirection
	)

Get the origin point and the normal direction of the mirror plane for the given linked mirrored part
Created in NX8.5.1.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

part	input linked mirror part. Error is raised if input is not a linked mirror part
mirrorPlaneOrigin	mirror plane origin
mirrorPlaneDirection	mirror plane normal direction

NXString NXOpen::PartCollection::GetSourcePartNameOfMirrorPart ( NXOpen::Part * mirrorPart )

Get source part name of mirror part.

Returns: Created in NX8.5.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

mirrorPart input part

NXOpen::Part* NXOpen::PartCollection::ImportToolDesignPackage	(	const NXString &	filename,
		const NXString &	outputDirectory,
		NXOpen::PartLoadStatus **	loadStatus,
		NXOpen::PartSaveStatus **	saveStatus
	)

Import tool design package.

Returns: Top level assembly
Created in NX9.0.0.

License requirements : None

Parameters

filename	Tool design package NOTE: The full Unicode character set is not supported for this parameter.
outputDirectory	Output directory NOTE: The full Unicode character set is not supported for this parameter.
loadStatus	Parts that could not be loaded and their associated errors.
saveStatus	Parts that could not be saved and their associated errors.

NXOpen::Part* NXOpen::PartCollection::ImportToolDesignPackage	(	const char *	filename,
		const char *	outputDirectory,
		NXOpen::PartLoadStatus **	loadStatus,
		NXOpen::PartSaveStatus **	saveStatus
	)

Import tool design package.

Returns: Top level assembly
Created in NX9.0.0.

License requirements : None

Parameters

filename	Tool design package NOTE: The full Unicode character set is not supported for this parameter.
outputDirectory	Output directory NOTE: The full Unicode character set is not supported for this parameter.
loadStatus	Parts that could not be loaded and their associated errors.
saveStatus	Parts that could not be saved and their associated errors.

bool NXOpen::PartCollection::IsExactMirroredPart ( NXOpen::Part * part )

Check whether given part is an exact linked mirrored part.

Returns: Created in NX8.5.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

part	input part

bool NXOpen::PartCollection::IsMirroredPart ( NXOpen::Part * part )

Check whether given part is a linked mirrored part.

Returns: Created in NX8.5.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

part	input part

NXOpen::LoadOptions* NXOpen::PartCollection::LoadOptions ( )

The NXOpen::LoadOptions that determines how parts are loaded in this session
Created in NX3.0.0.

NXOpen::BasePart* NXOpen::PartCollection::NewBaseDisplay	(	const NXString &	name,
		NXOpen::BasePart::Units	units
	)

Creates a new part and sets this part as the display part.

Returns: Newly created part
Created in NX4.0.0.

License requirements : None

Parameters

name	Name of new part NOTE: The full Unicode character set is not supported for this parameter.
units	Units of new part

NXOpen::BasePart* NXOpen::PartCollection::NewBaseDisplay	(	const char *	name,
		NXOpen::BasePart::Units	units
	)

Creates a new part and sets this part as the display part.

Returns: Newly created part
Created in NX4.0.0.

License requirements : None

Parameters

name	Name of new part NOTE: The full Unicode character set is not supported for this parameter.
units	Units of new part

NXOpen::Part* NXOpen::PartCollection::NewDisplay	(	const NXString &	name,
		NXOpen::Part::Units	units
	)

Creates a new .prt part and sets this part as the display part.

Note: This method should only be used to create new .prt parts. Use NXOpen::PartCollection::NewDisplay to create other types of parts other than .prt parts.

Returns: Newly created part
Created in NX3.0.0.

License requirements : None

Parameters

name	Name of new part NOTE: The full Unicode character set is not supported for this parameter.
units	Units of new part

NXOpen::Part* NXOpen::PartCollection::NewDisplay	(	const char *	name,
		NXOpen::Part::Units	units
	)

Creates a new .prt part and sets this part as the display part.

Note: This method should only be used to create new .prt parts. Use NXOpen::PartCollection::NewDisplay to create other types of parts other than .prt parts.

Returns: Newly created part
Created in NX3.0.0.

License requirements : None

Parameters

name	Name of new part NOTE: The full Unicode character set is not supported for this parameter.
units	Units of new part

NXOpen::PartCloseResponses* NXOpen::PartCollection::NewPartCloseResponses ( )

Constructs a new PartCloseResponses class.

This class is used to communicate whether to close certain parts if they are modified during part close.

Returns: Created in NX4.0.0.

License requirements : None

NXOpen::Part* NXOpen::PartCollection::Open	(	const NXString &	filename,
		NXOpen::PartLoadStatus **	loadStatus
	)

Opens an existing .prt part, but does not set it to be the displayed part.

See OpenDisplay .

Note: This method should only be used to open .prt parts. Use NXOpen::PartCollection::OpenBase to open other types of parts other than .prt parts.

Returns: Created in NX3.0.0.

License requirements : None

Parameters

filename	NOTE: The full Unicode character set is not supported for this parameter.
loadStatus	Parts that could not be loaded and their associated errors.

NXOpen::Part* NXOpen::PartCollection::Open	(	const char *	filename,
		NXOpen::PartLoadStatus **	loadStatus
	)

Opens an existing .prt part, but does not set it to be the displayed part.

See OpenDisplay .

Note: This method should only be used to open .prt parts. Use NXOpen::PartCollection::OpenBase to open other types of parts other than .prt parts.

Returns: Created in NX3.0.0.

License requirements : None

Parameters

filename	NOTE: The full Unicode character set is not supported for this parameter.
loadStatus	Parts that could not be loaded and their associated errors.

NXOpen::BasePart* NXOpen::PartCollection::OpenBase	(	const NXString &	filename,
		NXOpen::PartLoadStatus **	loadStatus
	)

Opens an existing part, but does not set it to be the displayed part.

See OpenBaseDisplay .

Note: This method can also be used to open bookmark files and parts other than .prt parts.

Returns: Created in NX4.0.0.

License requirements : None

Parameters

filename	NOTE: The full Unicode character set is not supported for this parameter.
loadStatus	Parts that could not be loaded and their associated errors.

NXOpen::BasePart* NXOpen::PartCollection::OpenBase	(	const char *	filename,
		NXOpen::PartLoadStatus **	loadStatus
	)

Opens an existing part, but does not set it to be the displayed part.

See OpenBaseDisplay .

Note: This method can also be used to open bookmark files and parts other than .prt parts.

Returns: Created in NX4.0.0.

License requirements : None

Parameters

filename	NOTE: The full Unicode character set is not supported for this parameter.
loadStatus	Parts that could not be loaded and their associated errors.

NXOpen::BasePart* NXOpen::PartCollection::OpenBaseDisplay	(	const NXString &	filename,
		NXOpen::PartLoadStatus **	loadStatus
	)

Opens an existing part and sets this part as the display part.

This method will load components in the following manner depending on how the NXOpen::LoadOptions::ComponentsToLoad property is set:
1) "All Components" (NXOpen::LoadOptions::LoadComponentsAll ) will load all components of the assembly.

2) "Last Used Component Set" (NXOpen::LoadOptions::LoadComponentsLastSet ) will load the components in the last saved component set.

3) "No Components" (NXOpen::LoadOptions::LoadComponentsNone ), "Use Last Filter" (NXOpen::LoadOptions::LoadComponentsLastFilter ) or "Specify Filter" (NXOpen::LoadOptions::LoadComponentsSpecifyFilter ) will load none of the components of the assembly.

Note: This method can also be used to open bookmark files and parts other than .prt parts.

Note: If this method is used in batch mode for a bookmark file which had been created using any of these options: BasePart::BookmarkOptionAllPlusDisplay BasePart::BookmarkOptionComponentGroupsLoadOptionsPlusDisplay BasePart::BookmarkOptionComponentGroupsOnlyPlusDisplay BasePart::BookmarkOptionDisplayOnly the display data in the bookmark file will not be applied to the displayed part.

Returns: Created in NX4.0.0.

License requirements : None

Parameters

filename	NOTE: The full Unicode character set is not supported for this parameter.
loadStatus	Parts that could not be loaded and their associated errors.

NXOpen::BasePart* NXOpen::PartCollection::OpenBaseDisplay	(	const char *	filename,
		NXOpen::PartLoadStatus **	loadStatus
	)

Opens an existing part and sets this part as the display part.

This method will load components in the following manner depending on how the NXOpen::LoadOptions::ComponentsToLoad property is set:
1) "All Components" (NXOpen::LoadOptions::LoadComponentsAll ) will load all components of the assembly.

2) "Last Used Component Set" (NXOpen::LoadOptions::LoadComponentsLastSet ) will load the components in the last saved component set.

3) "No Components" (NXOpen::LoadOptions::LoadComponentsNone ), "Use Last Filter" (NXOpen::LoadOptions::LoadComponentsLastFilter ) or "Specify Filter" (NXOpen::LoadOptions::LoadComponentsSpecifyFilter ) will load none of the components of the assembly.

Note: This method can also be used to open bookmark files and parts other than .prt parts.

Note: If this method is used in batch mode for a bookmark file which had been created using any of these options: BasePart::BookmarkOptionAllPlusDisplay BasePart::BookmarkOptionComponentGroupsLoadOptionsPlusDisplay BasePart::BookmarkOptionComponentGroupsOnlyPlusDisplay BasePart::BookmarkOptionDisplayOnly the display data in the bookmark file will not be applied to the displayed part.

Returns: Created in NX4.0.0.

License requirements : None

Parameters

filename	NOTE: The full Unicode character set is not supported for this parameter.
loadStatus	Parts that could not be loaded and their associated errors.

NXOpen::Part* NXOpen::PartCollection::OpenDisplay	(	const NXString &	filename,
		NXOpen::PartLoadStatus **	loadStatus
	)

Opens an existing .prt part and sets this part as the display part.

Note: This method should only be used to open .prt parts. Use NXOpen::PartCollection::OpenBaseDisplay to open other types of parts other than .prt parts.

This method will load components in the following manner depending on how the NXOpen::LoadOptions::ComponentsToLoad property is set:
1) "All Components" (NXOpen::LoadOptions::LoadComponentsAll ) will load all components of the assembly.

2) "Last Used Component Set" (NXOpen::LoadOptions::LoadComponentsLastSet ) will load the components in the last saved component set.

3) "No Components" (NXOpen::LoadOptions::LoadComponentsNone ), "Use Last Filter" (NXOpen::LoadOptions::LoadComponentsLastFilter ) or "Specify Filter" (NXOpen::LoadOptions::LoadComponentsSpecifyFilter ) will load none of the components of the assembly.

Returns: Created in NX3.0.0.

License requirements : None

Parameters

filename	NOTE: The full Unicode character set is not supported for this parameter.
loadStatus	Parts that could not be loaded and their associated errors.

NXOpen::Part* NXOpen::PartCollection::OpenDisplay	(	const char *	filename,
		NXOpen::PartLoadStatus **	loadStatus
	)

Opens an existing .prt part and sets this part as the display part.

Note: This method should only be used to open .prt parts. Use NXOpen::PartCollection::OpenBaseDisplay to open other types of parts other than .prt parts.

This method will load components in the following manner depending on how the NXOpen::LoadOptions::ComponentsToLoad property is set:
1) "All Components" (NXOpen::LoadOptions::LoadComponentsAll ) will load all components of the assembly.

2) "Last Used Component Set" (NXOpen::LoadOptions::LoadComponentsLastSet ) will load the components in the last saved component set.

3) "No Components" (NXOpen::LoadOptions::LoadComponentsNone ), "Use Last Filter" (NXOpen::LoadOptions::LoadComponentsLastFilter ) or "Specify Filter" (NXOpen::LoadOptions::LoadComponentsSpecifyFilter ) will load none of the components of the assembly.

Returns: Created in NX3.0.0.

License requirements : None

Parameters

filename	NOTE: The full Unicode character set is not supported for this parameter.
loadStatus	Parts that could not be loaded and their associated errors.

void NXOpen::PartCollection::OpenSeedPartBlankTemplate	(	const NXString &	filename,
		bool	addMaster
	)

Open unpopulated dataset with blank template
Created in NX6.0.0.

License requirements : None

Parameters

filename	Name of the part NOTE: The full Unicode character set is not supported for this parameter.
addMaster	whether to add master as component

void NXOpen::PartCollection::OpenSeedPartBlankTemplate	(	const char *	filename,
		bool	addMaster
	)

Open unpopulated dataset with blank template
Created in NX6.0.0.

License requirements : None

Parameters

filename	Name of the part NOTE: The full Unicode character set is not supported for this parameter.
addMaster	whether to add master as component

NXOpen::PDM::PartManager* NXOpen::PartCollection::PDMPartManager ( )

The NXOpen::PDM::PartManager that manages creation of parts in NX Manager mode
Created in NX3.0.0.

void NXOpen::PartCollection::RemovePartClosedHandler ( int id )

Unregisters a user defined method that is called whenever a part is in the process of being closed
Created in NX6.0.0.

License requirements : None

Parameters

id	identifier for method to unregister

void NXOpen::PartCollection::RemovePartCreatedHandler ( int id )

Unregisters a user defined method that is called whenever a new part is created
Created in NX6.0.0.

License requirements : None

Parameters

id	identifier for method to unregister

void NXOpen::PartCollection::RemovePartModifiedHandler ( int id )

Unregisters a user defined method that is called whenever a part is modified
Created in NX6.0.0.

License requirements : None

Parameters

id	identifier for method to unregister

void NXOpen::PartCollection::RemovePartOpenedHandler ( int id )

Unregisters a user defined method that is called whenever a part is opened
Created in NX6.0.0.

License requirements : None

Parameters

id	identifier for method to unregister

void NXOpen::PartCollection::RemovePartRenamedHandler ( int id )

Unregisters a user defined method that is called whenever a part is renamed
Created in NX6.0.0.

License requirements : None

Parameters

id	identifier for method to unregister

void NXOpen::PartCollection::RemovePartSavedAsHandler ( int id )

Unregisters a user defined method that is called whenever a part is saved as a specified name
Created in NX6.0.0.

License requirements : None

Parameters

id	identifier for method to unregister

void NXOpen::PartCollection::RemovePartSavedHandler ( int id )

Unregisters a user defined method that is called whenever a part is saved
Created in NX6.0.0.

License requirements : None

Parameters

id	identifier for method to unregister

void NXOpen::PartCollection::RemovePassword ( NXOpen::Part * part )

Remove password of the part.

This method should only be used with GC Toolkits.
Created in NX8.5.0.

License requirements : None

Parameters

part part

void NXOpen::PartCollection::RemoveWorkPartChangedHandler ( int id )

Unregisters a method that is called whenever the work part changes.

Do not create, open, save other parts or change display part inside this callback.
Created in NX6.0.0.

License requirements : None

Parameters

id	identifier for method to unregister

NXOpen::PartReopenReport* NXOpen::PartCollection::ReopenAll	(	NXOpen::BasePart::CloseModified	closeModified,
		NXOpen::PartCloseResponses *	responses
	)

Reopens all modified parts in the session.

Returns: Report containing results of reopen command
Created in NX4.0.0.

License requirements : None

Parameters

closeModified	Behavior of close if component parts are modified.
responses	Class representing list of parts to close or leave open if modified. Only used if closed_modified is set to NXOpen::BasePart::CloseModifiedUseResponses . If NXOpen::BasePart::CloseModifiedUseResponses is set, then any parts that are candidates for being closed that are not in this list will be closed whether modified or not. See NXOpen::PartCloseResponses for how to add responses to this class.

void NXOpen::PartCollection::SaveAll	(	bool *	anyPartsModified,
		NXOpen::PartSaveStatus **	saveStatus
	)

Saves all modified parts in a session.

Created in NX3.0.0.

License requirements : None

Parameters

anyPartsModified	Indicates whether any parts in the session were actually modified before the save operation was called. If false, then no parts were modified and, thus, a save was not attempted on any of the parts.
saveStatus	Parts that could not be saved and their associated errors.

NXOpen::SaveOptions* NXOpen::PartCollection::SaveOptions ( )

The NXOpen::SaveOptions that determines how parts are saved in this session
Created in NX3.0.0.

NXOpen::PartCollection::SdpsStatus NXOpen::PartCollection::SetDisplay	(	NXOpen::BasePart *	part,
		bool	maintainWorkPart,
		bool	setEntirePart,
		NXOpen::PartLoadStatus **	loadStatus
	)

Sets the displayed part.

Returns: Returns OK if the work part could be maintained, or a status code indicating the reason
Created in NX3.0.0.

License requirements : None

Parameters

part	The new displayed part
maintainWorkPart	If true, and if the current work part is a component of the new displayed part, then the work part remains unchanged. Otherwise the work part is set to the new displayed part.
setEntirePart	If true, and if maintain_work_part is true, the reference set of the work_component will be set to "Entire Part". If false, it will be left unchanged. See NXOpen::Assemblies::ComponentAssembly::ReplaceReferenceSet
loadStatus	Any errors found when loading the new work part.

void NXOpen::PartCollection::SetMirrorPartType	(	NXOpen::Part *	part,
		NXOpen::LinkedMirrorPartBuilder::MirrorPartTypeOption	mirrorOption
	)

Set the type of linked mirrored part
Created in NX8.5.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

part	input part
mirrorOption	mirroroption

void NXOpen::PartCollection::SetNonmasterSeedPartData ( const NXString & filename )

Set non master seed part data for opening unpopulated non master part
Created in NX6.0.0.

License requirements : None

Parameters

filename Name of the part
NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::PartCollection::SetNonmasterSeedPartData ( const char * filename )

Set non master seed part data for opening unpopulated non master part
Created in NX6.0.0.

License requirements : None

Parameters

filename Name of the part
NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::PartCollection::SetOpenPassword	(	const NXString &	fileName,
		const NXString &	password
	)

Input password to the current session.

This method should only be used with GC Toolkits.
Created in NX8.5.0.

License requirements : None

Parameters

fileName	filename
password	open password

void NXOpen::PartCollection::SetOpenPassword	(	const char *	fileName,
		const char *	password
	)

Input password to the current session.

This method should only be used with GC Toolkits.
Created in NX8.5.0.

License requirements : None

Parameters

fileName	filename
password	open password

void NXOpen::PartCollection::SetPassword	(	NXOpen::Part *	part,
		const NXString &	uAdminPassword,
		const NXString &	uReadPassword,
		const NXString &	uWritePassword,
		const NXString &	uFullControlPassword
	)

Set password to the part.

This method should only be used with GC Toolkits.
Created in NX8.5.0.

License requirements : None

Parameters

part	part
uAdminPassword	admin password
uReadPassword	read password
uWritePassword	write password
uFullControlPassword	full control password

void NXOpen::PartCollection::SetPassword	(	NXOpen::Part *	part,
		const char *	uAdminPassword,
		const char *	uReadPassword,
		const char *	uWritePassword,
		const char *	uFullControlPassword
	)

Set password to the part.

This method should only be used with GC Toolkits.
Created in NX8.5.0.

License requirements : None

Parameters

part	part
uAdminPassword	admin password
uReadPassword	read password
uWritePassword	write password
uFullControlPassword	full control password

void NXOpen::PartCollection::SetSeedPartTemplateData	(	const NXString &	filename,
		const NXString &	templateName,
		bool	addMaster
	)

Specify template data to open seed part or empty item revision
Created in NX6.0.0.

License requirements : None

Parameters

filename	Name of the part NOTE: The full Unicode character set is not supported for this parameter.
templateName	Name of the template NOTE: The full Unicode character set is not supported for this parameter.
addMaster	Whether master should be added as child

void NXOpen::PartCollection::SetSeedPartTemplateData	(	const char *	filename,
		const char *	templateName,
		bool	addMaster
	)

Specify template data to open seed part or empty item revision
Created in NX6.0.0.

License requirements : None

Parameters

filename	Name of the part NOTE: The full Unicode character set is not supported for this parameter.
templateName	Name of the template NOTE: The full Unicode character set is not supported for this parameter.
addMaster	Whether master should be added as child

void NXOpen::PartCollection::SetWork ( NXOpen::BasePart * part )

Sets the current work part.

The work component will be set to one of the visible components that represent this part in the current visible assembly. See SetWorkComponent . If no visible component is available, then an exception is thrown.

Created in NX3.0.0.

License requirements : None

Parameters

part	The new work part.

void NXOpen::PartCollection::SetWorkComponent	(	NXOpen::Assemblies::Component *	workComponent,
		NXOpen::PartLoadStatus **	loadStatus
	)

Sets the work component.

If the part represented by the new work component is not already the work part, then sets the work part appropriately. The new component's reference set will be set to "Entire Part".
Note that if the given work component is not visible, but an alternative component which represents the same part is visible, then the alternative component will be chosen as the new work component. If no visible component can be found, an exception is thrown

Created in NX3.0.0.

License requirements : None

Parameters

workComponent	The new work component. This must be a component defined in the NXOpen::Assemblies::ComponentAssembly of the current displayed part. May be NULL, in which case the work part is reset to the displayed part.
loadStatus	Any errors found when loading the new work part.

void NXOpen::PartCollection::SetWorkComponent	(	NXOpen::Assemblies::Component *	workComponent,
		NXOpen::PartCollection::RefsetOption	refsetOption,
		NXOpen::PartCollection::WorkComponentOption	visibility,
		NXOpen::PartLoadStatus **	loadStatus
	)

Sets the work component.

If the part represented by the new work component is not already the work part, then sets the work part appropriately.

Created in NX3.0.0.

License requirements : None

Parameters

workComponent	The new work component. This must be a component defined in the NXOpen::Assemblies::ComponentAssembly of the current displayed part. May be NULL, in which case the work part is reset to the displayed part.
refsetOption	Controls the reference set of the new component.
visibility	Controls the behavior if the new component is not visible
loadStatus	Any errors found when loading the new work part.

NXOpen::PartLoadStatus* NXOpen::PartCollection::SetWorkComponentOverride ( NXOpen::Assemblies::Component * workComponent )

Sets the component with override part as the work component.

Error is raised, if component doesn't have override part.

Returns: Any errors found when loading the new work part.
Created in NX10.0.0.

License requirements : None

Parameters

workComponent The new work component. This must be a component defined in the NXOpen::Assemblies::ComponentAssembly of the current displayed part.

NXOpen::ShapeSearch::SearchManager* NXOpen::PartCollection::ShapeSearchManager ( )

The NXOpen::ShapeSearch::SearchManager that manages shape search in this session
Created in NX6.0.0.

void NXOpen::PartCollection::SolveAllPostponedConstraints ( )

Solves all the constraints, that have been postponed in their arrangement, in every loaded part in the session.

This could lead to updating the model if required.

Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

tag_t NXOpen::PartCollection::Tag ( ) const

Returns the tag of this object.

NXOpen::Part* NXOpen::PartCollection::Work ( )

Returns the current work part of the session.

This is either the displayed part, or a part represented by a component in the displayed part's NXOpen::Assemblies::ComponentAssembly . See: NXOpen::PartCollection::WorkComponent

An error will be thrown if the work part is not a .prt part.

Created in NX3.0.0.

License requirements : None

NXOpen::Assemblies::Component* NXOpen::PartCollection::WorkComponent ( )

Returns the work component.

This is the component in the displayed part's NXOpen::Assemblies::ComponentAssembly which represents the current work part. Note that there may be several different components which represent the same work part. In this case, one of them will be selected as the work component, while the others will be greyed out on the main display.

Created in NX3.0.0.

License requirements : None

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

PartCollection.hxx

Classes

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Member Function Documentation