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
enum	MultipleDisplayedPartStatus { MultipleDisplayedPartStatusEnabled, MultipleDisplayedPartStatusDisabledByCustomer, MultipleDisplayedPartStatusDisabled }
	Represents the status if Multiple Display Parts are allowed or not. More...

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 active 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	SetProtectionOn { SetProtectionOnDisplayedPart, SetProtectionOnDisplayedPartandComponents, SetProtectionOnAllParts }
	Specifies the parts to which the password protection operation will apply. 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 has changed. 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::PartCollection::MultipleDisplayedPartStatus	AllowMultipleDisplayedParts ()
	Returns. More...

NXOpen::BasePart *	BaseDisplay ()
	Returns the currently active 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...

void	ClosePasswordSafe ()
	This method is for closing the currently open password safe. More...

NXOpen::Gateway::GenericFileNewBuilder *	CreateGenericFileNewBuilder ()
	Creates a NXOpen::Gateway::GenericFileNewBuilder. More...

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

NXOpen::Part *	Display ()
	Returns the currently active 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 parts in a session. More...

std::vector< NXOpen::BasePart * >	GetDisplayedParts ()
	Returns all parts that are currently displayed. 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 active display part. More...

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

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

NXOpen::Part *	NewDisplay (const char *name, NXOpen::Part::Units units)
	Creates a new .prt part and sets this part as the active 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 active display part. More...

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

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

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

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

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

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

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

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

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

void	OpenPasswordSafe (const NXString &fileName, const NXString &password)
	This method is for opening a password safe. More...

void	OpenPasswordSafe (const char fileName, const char password)
	This method is for opening a password safe. 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	RefreshPartNavigator ()
	Refreshes the part navigator. 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	RemovePassword (NXOpen::Part *part, NXOpen::PartCollection::SetProtectionOn partoption)
	This method is for deleting security on part(s). 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	SetActiveDisplay (NXOpen::BasePart part, NXOpen::DisplayPartOption displayPartOption, NXOpen::PartDisplayPartWorkPartOption workPartOption, NXOpen::PartLoadStatus *loadStatus)
	Sets the active display part. More...

void	SetAllowMultipleDisplayedParts (bool additionalPartsDisplayed)
	Sets the option indicating if more than one displayed part is allowed in this session. More...

NXOpen::PartCollection::SdpsStatus	SetDisplay (NXOpen::BasePart part, bool maintainWorkPart, bool setEntirePart, NXOpen::PartLoadStatus *loadStatus)
	Sets the active display 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 for opening the part. More...

void	SetOpenPassword (const char fileName, const char password)
	Input password for opening the part. 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	SetPassword (NXOpen::Part *part, const NXString &adminPassword, const NXString &readPassword, const NXString &writePassword, const NXString &fullControlPassword, NXOpen::PartCollection::SetProtectionOn partoption)
	This method is for setting a new password for a part. More...

void	SetPassword (NXOpen::Part part, const char adminPassword, const char readPassword, const char writePassword, const char *fullControlPassword, NXOpen::PartCollection::SetProtectionOn partoption)
	This method is for setting a new password for a 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 in the active display part. More...

void	SetWorkComponent (NXOpen::Assemblies::Component workComponent, NXOpen::PartLoadStatus *loadStatus)
	Sets the work component in the currently active display part. More...

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

NXOpen::PartLoadStatus *	SetWorkComponentOverride (NXOpen::Assemblies::Component *workComponent)
	Sets the component with override part as the work component in the active display part. 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 active 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 active 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 active 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 active 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 active 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 has changed.

This method will be called after a work part change has occurred. This method may be called at times where the previous work part (which is passed as the part to this method) may not necessarily be different from the new work part. For example, this method is also called if the active display part has changed but the new work part is still the same part and now represents a different component in the new active display part. This method may be called more than once as part of a single operation. Do not change active display part, work part or work component in this method.

Created in NX6.0.0.

License requirements : None

Member Enumeration Documentation

enum NXOpen::PartCollection::MultipleDisplayedPartStatus

Represents the status if Multiple Display Parts are allowed or not.

Enumerator

MultipleDisplayedPartStatusEnabled

It is possible to have more than one part be displayed (i.e.

additional different displayed parts).

MultipleDisplayedPartStatusDisabledByCustomer

Indicates that only one part can be displayed at a time.

Multiple Displayed Parts was disabled by the customer, for example by disabling it through NXOpen::PartCollection::SetAllowMultipleDisplayedParts rather than by the NX session itself.

MultipleDisplayedPartStatusDisabled

Indicates that only one part can be displayed at a time.

Multiple Display Parts is disabled by the NX session and not the customer.

enum NXOpen::PartCollection::RefsetOption

Controls the reference set used when setting the work component.

See NXOpen::PartCollection::SetWorkComponent

Enumerator
RefsetOptionEntire	Use the "Entire Part" reference set for the new work component, and restore the reference set of the previous work component.
RefsetOptionCurrent	Use the component's current reference set, and restore the reference set of the previous work component.
RefsetOptionPreserveRefset	Use the component's current reference set, and do not reset the reference set of the previous work component.

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 new active 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::SetProtectionOn

Specifies the parts to which the password protection operation will apply.

This structure should only be used with GC Toolkits.

Enumerator
SetProtectionOnDisplayedPart	The Displayed part.
SetProtectionOnDisplayedPartandComponents	All fully open parts in the session.
SetProtectionOnAllParts	Displayed part and full open components of the part.

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::PartCollection::MultipleDisplayedPartStatus NXOpen::PartCollection::AllowMultipleDisplayedParts ( )

Returns.

the option indicating if more than one displayed part is allowed in this session.

Created in NX12.0.0.

License requirements : None

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

Returns the currently active 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 active display part, or a part represented by a component in the active display 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.

void NXOpen::PartCollection::ClosePasswordSafe ( )

This method is for closing the currently open password safe.

This method should only be used with GC Toolkits.
Created in NX11.0.0.

License requirements : None

NXOpen::Gateway::GenericFileNewBuilder* NXOpen::PartCollection::CreateGenericFileNewBuilder ( )

Creates a NXOpen::Gateway::GenericFileNewBuilder.

Returns: Created in NX11.0.0.

License requirements : None

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 currently active display part of the session.

An error will be thrown if the active 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. This function acceps full path name or leaf name in case of native mode and would expect CLI format name (e.g., "@DB/peters-part/A/spec/sheet1") in case of managed mode NX. 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	Full name or leaf name or CLI name (in managed mode)

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. This function acceps full path name or leaf name in case of native mode and would expect CLI format name (e.g., "@DB/peters-part/A/spec/sheet1") in case of managed mode NX. 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	Full name or leaf name or CLI name (in managed mode)

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

Saves all parts in a session.

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

License requirements : None

std::vector<NXOpen::BasePart *> NXOpen::PartCollection::GetDisplayedParts ( )

Returns all parts that are currently displayed.

The first part in this list will be the active display part. See also NXOpen::PartCollection::Display , NXOpen::PartCollection::Work

Note: NX operations are generally performed in the active display part. Before performing operations in a display part you should first activate it with NXOpen::PartCollection::SetActiveDisplay .

Returns: Parts that are currently displayed
Created in NX12.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
outputDirectory	Output directory
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
outputDirectory	Output directory
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 active display part.

Returns: Newly created part
Created in NX4.0.0.

License requirements : None

Parameters

name	Name of new part
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 active display part.

Returns: Newly created part
Created in NX4.0.0.

License requirements : None

Parameters

name	Name of new part
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 active display part.

Note: This method should only be used to create new .prt parts. Use NXOpen::PartCollection::NewBaseDisplay 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
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 active display part.

Note: This method should only be used to create new .prt parts. Use NXOpen::PartCollection::NewBaseDisplay 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
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 active display 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	filename
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 active display 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	filename
loadStatus	Parts that could not be loaded and their associated errors.

NXOpen::BasePart* NXOpen::PartCollection::OpenActiveDisplay	(	const NXString &	filename,
		NXOpen::DisplayPartOption	displayPartOption,
		NXOpen::PartLoadStatus **	loadStatus
	)

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

Depending on the input options this part may be displayed in addition to other, already displayed part. See also See NXOpen::DisplayPartOption .

Returns: Created in NX12.0.0.

License requirements : None

Parameters

filename	filename
displayPartOption	Controls whether or not the part will replace the existing active display part.
loadStatus	Parts that could not be loaded and their associated errors and warnings.

NXOpen::BasePart* NXOpen::PartCollection::OpenActiveDisplay	(	const char *	filename,
		NXOpen::DisplayPartOption	displayPartOption,
		NXOpen::PartLoadStatus **	loadStatus
	)

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

Depending on the input options this part may be displayed in addition to other, already displayed part. See also See NXOpen::DisplayPartOption .

Returns: Created in NX12.0.0.

License requirements : None

Parameters

filename	filename
displayPartOption	Controls whether or not the part will replace the existing active display part.
loadStatus	Parts that could not be loaded and their associated errors and warnings.

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

Opens an existing part, but does not set it to be the active display 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	filename
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 active display 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	filename
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 active display part.

This is equivalent to OpenActiveDisplay with the option NXOpen::DisplayPartOptionReplaceExisting .

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 active display part.

Returns: Created in NX4.0.0.

License requirements : None

Parameters

filename	filename
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 active display part.

This is equivalent to OpenActiveDisplay with the option NXOpen::DisplayPartOptionReplaceExisting .

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 active display part.

Returns: Created in NX4.0.0.

License requirements : None

Parameters

filename	filename
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 active 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	filename
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 active 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	filename
loadStatus	Parts that could not be loaded and their associated errors.

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

This method is for opening a password safe.

This method should only be used with GC Toolkits.
Created in NX11.0.0.

License requirements : None

Parameters

fileName	filename
password	open password

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

This method is for opening a password safe.

This method should only be used with GC Toolkits.
Created in NX11.0.0.

License requirements : None

Parameters

fileName	filename
password	open password

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
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
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::RefreshPartNavigator ( )

Refreshes the part navigator.

This function cycles through all of the nodes in the Part Navigator and updates each one. Do not call when efficiency is important (i.e. in a tight loop).

Deprecated:: Deprecated in NX12.0.0. A direct call to refresh the part navigator should not be needed.

Created in NX10.0.1.

License requirements : None

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.

Deprecated:: Deprecated in NX11.0.0. Use overloaded RemovePassword instead.

Created in NX8.5.0.

License requirements : None

Parameters

part part

void NXOpen::PartCollection::RemovePassword	(	NXOpen::Part *	part,
		NXOpen::PartCollection::SetProtectionOn	partoption
	)

This method is for deleting security on part(s).

This method should only be used with GC Toolkits.
Created in NX11.0.0.

License requirements : None

Parameters

part	part
partoption	parts on which security is to be removed.

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

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

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::SetActiveDisplay	(	NXOpen::BasePart *	part,
		NXOpen::DisplayPartOption	displayPartOption,
		NXOpen::PartDisplayPartWorkPartOption	workPartOption,
		NXOpen::PartLoadStatus **	loadStatus
	)

Sets the active display part.

Depending on the input options this part may be displayed in addition to other, already displayed part. See also See NXOpen::DisplayPartOption .

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

License requirements : None

Parameters

part	The new displayed part
displayPartOption	Controls whether or not the part will replace the existing active display part.
workPartOption	Controls what the work part will be in the new active display part.
loadStatus	Any errors and warnings found when loading the new display part.

void NXOpen::PartCollection::SetAllowMultipleDisplayedParts ( bool additionalPartsDisplayed )

Sets the option indicating if more than one displayed part is allowed in this session.

When the value is changed to false all inactive displayed parts will be undisplayed and only the active part, if any, is left visible. Any future operations that change active display part will not cause multiple parts to be displayed at the same time. Instead, the contents of the single active graphics window will be replaced with the new displayed part. See also NXOpen::PartCollection::SetActiveDisplay . Queries to NXOpen::PartCollection::AllowMultipleDisplayedParts will return NXOpen::PartCollection::MultipleDisplayedPartStatusDisabledByCustomer .

When the value is changed to true, NX will allow multiple displayed parts. This will not restore any previously removed inactive windows.

This option will rollback on undo.

Created in NX12.0.0.

License requirements : None

Parameters

additionalPartsDisplayed additionalpartsdisplayed

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

Sets the active display part.

This is equivalent to NXOpen::PartCollection::SetActiveDisplay with the option NXOpen::DisplayPartOptionReplaceExisting .

Returns: Returns OK if the work part could be set as requested, or a status code indicating the reason why this was not possible.
Created in NX3.0.0.

License requirements : None

Parameters

part	The new active display part
maintainWorkPart	If true, and if the current work part is a component of the new active display part, then the work part remains unchanged. Otherwise the work part is set to the new active display 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 and warnings found when loading the new display 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

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

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

Input password for opening the part.

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 for opening the part.

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.

Deprecated:: Deprecated in NX11.0.0. Use overloaded SetPassword instead.

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.

Deprecated:: Deprecated in NX11.0.0. Use overloaded SetPassword instead.

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 NXString &	adminPassword,
		const NXString &	readPassword,
		const NXString &	writePassword,
		const NXString &	fullControlPassword,
		NXOpen::PartCollection::SetProtectionOn	partoption
	)

This method is for setting a new password for a part.

Once a password is set the part can not be recovered if the original password is lost or forgotten. Store the password in a safe and secure location. This method should only be used with GC Toolkits.
Created in NX11.0.0.

License requirements : None

Parameters

part	part
adminPassword	admin password
readPassword	read password
writePassword	write password
fullControlPassword	full control password
partoption	parts on which security is to be added.

void NXOpen::PartCollection::SetPassword	(	NXOpen::Part *	part,
		const char *	adminPassword,
		const char *	readPassword,
		const char *	writePassword,
		const char *	fullControlPassword,
		NXOpen::PartCollection::SetProtectionOn	partoption
	)

This method is for setting a new password for a part.

Once a password is set the part can not be recovered if the original password is lost or forgotten. Store the password in a safe and secure location. This method should only be used with GC Toolkits.
Created in NX11.0.0.

License requirements : None

Parameters

part	part
adminPassword	admin password
readPassword	read password
writePassword	write password
fullControlPassword	full control password
partoption	parts on which security is to be added.

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
templateName	Name of the template
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
templateName	Name of the template
addMaster	Whether master should be added as child

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

Sets the current work part in the active display part.

The work component will be set to one of the visible components that represent this part in the currently active display part. 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 in the currently active display part.

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 active display part. May be NULL, in which case the work part is reset to the active display 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 in the active display part.

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 active display part. May be NULL, in which case the work part is reset to the active display 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 in the active display part.

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 active display 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 active display part, or a part represented by a component in the active display 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 active display 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.

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