Represents a builder class that performs various design element operations. More...

Inheritance diagram for NXOpen::PDM::PartOperationBuilder:

Public Types
enum	DependentFileSaveAs { DependentFileSaveAsAll, DependentFileSaveAsNone }
	This enum is used to specify which dependent files should be saved during the save as operation. More...

enum	NonMasterSaveAs { NonMasterSaveAsAll, NonMasterSaveAsNone }
	This enum is used to specify which non-master parts should be saved during the save as operation. More...

enum	OperationType { OperationTypeSaveAs, OperationTypeRevise }
	Represents an operation type that can be performed on a part. More...

Public Member Functions
void	AddRelatedPartToOperate (NXOpen::BasePart basePart, const std::vector< NXOpen::BasePart > &relatedParts, std::vector< NXString > &relatedPartsReasons, NXOpen::PDM::PartOperationBuilder::OperationType operation)
	Add related part to the part undergoing an operation.

virtual NXOpen::ErrorList *	AutoAssignAttributes (const std::vector< NXOpen::NXObject * > &objects)
	Auto assigns the attributes for a given array of objects and returns an array of objects that failed to auto assign.

void	CreateLogicalObjects (std::vector< NXOpen::PDM::LogicalObject * > &logicalObjects)
	Creates the pre-creation objects for the parts Created in NX9.0.0.

void	CreateNonMasterListForLogicalObject (NXOpen::PDM::LogicalObject *logicalObject)
	Create NonMaster list for the selected logical Object Created in NX9.0.0.

void	CreateSpecificationsForLogicalObjects (const std::vector< NXOpen::PDM::LogicalObject * > &logicalObjects)
	Create new specifications for Logical Objects Created in NX9.0.0.

NXOpen::PDM::PartOperationBuilder::DependentFileSaveAs	DependentFileSaveAsOption ()
	Returns the Dependent files Save As option.

bool	EditNonMasterName (NXOpen::PDM::LogicalObject *logicalObject, const NXString &oldName, const NXString &newName)
	Sets the name the non-master part will get saved as.

bool	EditNonMasterName (NXOpen::PDM::LogicalObject logicalObject, const char oldName, const char *newName)
	Sets the name the non-master part will get saved as.

NXOpen::PDM::AlternateIdManager *	GetAlternateIDManager (NXOpen::PDM::LogicalObject *logicalObject)
	Create an instance of a PDM::AlternateIdManager class that will be used to create alternate ID information while creating the new part.

NXOpen::PDM::PartOperationBuilder::OperationType	GetDialogOperation ()
	Returns the dialog operation Applicable only for operation types PartOperationBuilder::OperationTypeSaveAs and PartOperationBuilder::OperationTypeRevise.

NXOpen::ErrorList *	GetOperationFailures ()
	Returns part operation failures.

bool	ReplaceAllComponents ()
	Returns the replace all components.

void	SetDependentFileSaveAsOption (NXOpen::PDM::PartOperationBuilder::DependentFileSaveAs saveOption)
	Sets the Dependent files Save As option.

void	SetDialogOperation (NXOpen::PDM::PartOperationBuilder::OperationType dialogOperation)
	Sets the dialog operation.

void	SetNonMasterSaveAsOption (NXOpen::PDM::LogicalObject *logicalObject, NXOpen::PDM::PartOperationBuilder::NonMasterSaveAs saveOption)
	Set the nonmasters saveAs option for given logical object Created in NX9.0.0.

void	SetReplaceAllComponents (bool replaceAllComponents)
	Sets the replace all components.

void	SetSelectedNonMasterToSaveAs (NXOpen::PDM::LogicalObject *logicalObject, const NXString &partName)
	Sets whether or not the non-master part specified will actually get saved during the save as operation.

void	SetSelectedNonMasterToSaveAs (NXOpen::PDM::LogicalObject logicalObject, const char partName)
	Sets whether or not the non-master part specified will actually get saved during the save as operation.

void	SetSelectedParts (const std::vector< NXOpen::BasePart * > &selectedParts, std::vector< NXOpen::BasePart * > &failedParts)
	Sets the selected parts.

void	ValidateLogicalObjectsToCommit ()
	Validates PDM::LogicalObject objects with this builder and udpates the operation failuers.

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

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

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

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

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

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

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

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

Detailed Description

Represents a builder class that performs various design element operations.

   The operation can be one of @link PDM::PartOperationBuilder::OperationType PDM::PartOperationBuilder::OperationType@endlink   <br> To create a new instance of this class, use @link PDM::PdmSession::CreateOperationBuilder  PDM::PdmSession::CreateOperationBuilder @endlink  <br>

Created in NX9.0.0.

Member Enumeration Documentation

enum NXOpen::PDM::PartOperationBuilder::DependentFileSaveAs

This enum is used to specify which dependent files should be saved during the save as operation.

Enumerator:

DependentFileSaveAsAll	save all during save as
DependentFileSaveAsNone	save none during save as

enum NXOpen::PDM::PartOperationBuilder::NonMasterSaveAs

This enum is used to specify which non-master parts should be saved during the save as operation.

Enumerator:

NonMasterSaveAsAll	save all during save as
NonMasterSaveAsNone	save none during save as

enum NXOpen::PDM::PartOperationBuilder::OperationType

Represents an operation type that can be performed on a part.

Enumerator:

OperationTypeSaveAs	Save As Part.
OperationTypeRevise	Revise Part.

Member Function Documentation

void NXOpen::PDM::PartOperationBuilder::AddRelatedPartToOperate	(	NXOpen::BasePart *	basePart,
		const std::vector< NXOpen::BasePart * > &	relatedParts,
		std::vector< NXString > &	relatedPartsReasons,
		NXOpen::PDM::PartOperationBuilder::OperationType	operation
	)

Add related part to the part undergoing an operation.

Example: if user selects a part for Save As which has Linked Part Modules that should also undergo Save As, they should be added as related parts. Applicable only for operation types PartOperationBuilder::OperationTypeSaveAs and PartOperationBuilder::OperationTypeRevise
Created in NX9.0.0.

License requirements : None

Parameters

basePart	basepart
relatedParts	relatedparts
relatedPartsReasons	relatedpartsreasons
operation	operation

virtual NXOpen::ErrorList* NXOpen::PDM::PartOperationBuilder::AutoAssignAttributes ( const std::vector< NXOpen::NXObject * > & objects )

virtual

Auto assigns the attributes for a given array of objects and returns an array of objects that failed to auto assign.

Returns: Created in NX8.5.0.

License requirements : None

Parameters

objects objects

Implements NXOpen::IAttributeSourceObjectBuilder.

void NXOpen::PDM::PartOperationBuilder::CreateLogicalObjects ( std::vector< NXOpen::PDM::LogicalObject * > & logicalObjects )

Creates the pre-creation objects for the parts
Created in NX9.0.0.

License requirements : None

Parameters

logicalObjects logicalobjects

void NXOpen::PDM::PartOperationBuilder::CreateNonMasterListForLogicalObject ( NXOpen::PDM::LogicalObject * logicalObject )

Create NonMaster list for the selected logical Object
Created in NX9.0.0.

License requirements : None

Parameters

logicalObject logicalobject

void NXOpen::PDM::PartOperationBuilder::CreateSpecificationsForLogicalObjects ( const std::vector< NXOpen::PDM::LogicalObject * > & logicalObjects )

Create new specifications for Logical Objects
Created in NX9.0.0.

License requirements : None

Parameters

logicalObjects logicalobjects

NXOpen::PDM::PartOperationBuilder::DependentFileSaveAs NXOpen::PDM::PartOperationBuilder::DependentFileSaveAsOption ( )

Returns the Dependent files Save As option.

Save As option can be one of these PartOperationBuilder::DependentFileSaveAsAll and PartOperationBuilder::DependentFileSaveAsNone
Created in NX9.0.0.

License requirements : None

bool NXOpen::PDM::PartOperationBuilder::EditNonMasterName	(	NXOpen::PDM::LogicalObject *	logicalObject,
		const NXString &	oldName,
		const NXString &	newName
	)

Sets the name the non-master part will get saved as.

It will get saved as the original non-master name if this method is not called.

Returns: flag to indicate whether the newName is valid
Created in NX9.0.0.

License requirements : None

Parameters

logicalObject	logicalobject
oldName	the non-master part whose save as name is being set here NOTE: The full Unicode character set is not supported for this parameter.
newName	the new name NOTE: The full Unicode character set is not supported for this parameter.

bool NXOpen::PDM::PartOperationBuilder::EditNonMasterName	(	NXOpen::PDM::LogicalObject *	logicalObject,
		const char *	oldName,
		const char *	newName
	)

Sets the name the non-master part will get saved as.

It will get saved as the original non-master name if this method is not called.

Returns: flag to indicate whether the newName is valid
Created in NX9.0.0.

License requirements : None

Parameters

logicalObject	logicalobject
oldName	the non-master part whose save as name is being set here NOTE: The full Unicode character set is not supported for this parameter.
newName	the new name NOTE: The full Unicode character set is not supported for this parameter.

NXOpen::PDM::AlternateIdManager* NXOpen::PDM::PartOperationBuilder::GetAlternateIDManager ( NXOpen::PDM::LogicalObject * logicalObject )

Create an instance of a PDM::AlternateIdManager class that will be used to create alternate ID information while creating the new part.

   CreateSpec call should happen before calling this method. @return  the new @link PDM::AlternateIdManager PDM::AlternateIdManager@endlink  instance

Created in NX9.0.0.

License requirements : None

Parameters

logicalObject logicalobject

NXOpen::PDM::PartOperationBuilder::OperationType NXOpen::PDM::PartOperationBuilder::GetDialogOperation ( )

Returns the dialog operation Applicable only for operation types PartOperationBuilder::OperationTypeSaveAs and PartOperationBuilder::OperationTypeRevise.

Returns: Created in NX9.0.0.

License requirements : None

NXOpen::ErrorList* NXOpen::PDM::PartOperationBuilder::GetOperationFailures ( )

Returns part operation failures.

Returns: Created in NX9.0.0.

License requirements : None

bool NXOpen::PDM::PartOperationBuilder::ReplaceAllComponents ( )

Returns the replace all components.

This option specifies whether part will be replaced or copied. Applicable only for operation types PartOperationBuilder::OperationTypeSaveAs and PartOperationBuilder::OperationTypeRevise
Created in NX9.0.0.

License requirements : None

void NXOpen::PDM::PartOperationBuilder::SetDependentFileSaveAsOption ( NXOpen::PDM::PartOperationBuilder::DependentFileSaveAs saveOption )

Sets the Dependent files Save As option.

Save As option can be one of these PartOperationBuilder::DependentFileSaveAsAll and PartOperationBuilder::DependentFileSaveAsNone
Created in NX9.0.0.

License requirements : None

Parameters

saveOption saveoption

void NXOpen::PDM::PartOperationBuilder::SetDialogOperation ( NXOpen::PDM::PartOperationBuilder::OperationType dialogOperation )

Sets the dialog operation.

Applicable only for operation types PartOperationBuilder::OperationTypeSaveAs and PartOperationBuilder::OperationTypeRevise
Created in NX9.0.0.

License requirements : None

Parameters

dialogOperation dialogoperation

void NXOpen::PDM::PartOperationBuilder::SetNonMasterSaveAsOption	(	NXOpen::PDM::LogicalObject *	logicalObject,
		NXOpen::PDM::PartOperationBuilder::NonMasterSaveAs	saveOption
	)

Set the nonmasters saveAs option for given logical object
Created in NX9.0.0.

License requirements : None

Parameters

logicalObject	logicalobject
saveOption	saveoption

void NXOpen::PDM::PartOperationBuilder::SetReplaceAllComponents ( bool replaceAllComponents )

Sets the replace all components.

This option specifies whether part will be replaced or copied. Applicable only for operation types PartOperationBuilder::OperationTypeSaveAs and PartOperationBuilder::OperationTypeRevise
Created in NX9.0.0.

License requirements : None

Parameters

replaceAllComponents replaceallcomponents

void NXOpen::PDM::PartOperationBuilder::SetSelectedNonMasterToSaveAs	(	NXOpen::PDM::LogicalObject *	logicalObject,
		const NXString &	partName
	)

Sets whether or not the non-master part specified will actually get saved during the save as operation.

True means that it will be saved. False means that it will not be saved.
Created in NX9.0.0.

License requirements : None

Parameters

logicalObject	logicalobject
partName	the non-master part whose save option is being set here NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::PDM::PartOperationBuilder::SetSelectedNonMasterToSaveAs	(	NXOpen::PDM::LogicalObject *	logicalObject,
		const char *	partName
	)

Sets whether or not the non-master part specified will actually get saved during the save as operation.

True means that it will be saved. False means that it will not be saved.
Created in NX9.0.0.

License requirements : None

Parameters

logicalObject	logicalobject
partName	the non-master part whose save option is being set here NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::PDM::PartOperationBuilder::SetSelectedParts	(	const std::vector< NXOpen::BasePart * > &	selectedParts,
		std::vector< NXOpen::BasePart * > &	failedParts
	)

Sets the selected parts.

Applicable only for operation types PartOperationBuilder::OperationTypeSaveAs and PartOperationBuilder::OperationTypeRevise Also returns an array of parts failed to added, these are not removed from the input array though. PDM::PartOperationBuilder::GetOperationFailures can be called to get the errors occurred during this operation.

Created in NX9.0.0.

License requirements : None

Parameters

selectedParts	selectedparts
failedParts	failedparts

void NXOpen::PDM::PartOperationBuilder::ValidateLogicalObjectsToCommit ( )

Validates PDM::LogicalObject objects with this builder and udpates the operation failuers.

   @link PDM::PartOperationBuilder::GetOperationFailures PDM::PartOperationBuilder::GetOperationFailures@endlink  can be called to get the errors occurred
   during this operation.

Created in NX9.0.0.

License requirements : None

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

PDM_PartOperationBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation