NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::PDM::PartFromPartBuilder Class Reference

This class provides the methods necessary to create a new part in NX Manager from an existing part. More...

Inheritance diagram for NXOpen::PDM::PartFromPartBuilder:
NXOpen::PDM::PartBuilder NXOpen::TransientObject

List of all members.

Public Types

enum  FileSaveAs { FileSaveAsSome, FileSaveAsAll, FileSaveAsNone }
 This enum is used to specify which non-master parts and dependent files should be saved during the save as operation. More...

Public Member Functions

void Commit ()
 Creates the new part that has been fully-specified by calling methods on this builder.
void CreateNonmasterList ()
 Initializes the list of non-master parts that can be saved during the save as operation.
NXOpen::PDM::PartFromPartBuilder::FileSaveAs DependentFileSaveAsOption ()
 Returns the dependent files to save during the save as operation
Created in NX4.0.0.
bool EditNonmasterNameToSaveAs (const NXString &oldName, const NXString &newName)
 Sets the name the non-master part will get saved as.
bool GetNonmasterToSaveAs (const NXString &partName)
 Returns whether or not the non-master part specified will actually get saved during the save as operation.
NXOpen::PDM::PartFromPartBuilder::FileSaveAs NonmasterSaveAsOption ()
 Returns the non-master parts to save during the save as operation
Created in NX4.0.0.
void SetDependentFileSaveAsOption (NXOpen::PDM::PartFromPartBuilder::FileSaveAs saveOption)
 Sets the dependent files to save during the save as operation
Created in NX4.0.0.
void SetNonmasterSaveAsOption (NXOpen::PDM::PartFromPartBuilder::FileSaveAs saveOption)
 Sets the non-master parts to save during the save as operation
Created in NX4.0.0.
void SetNonmasterToSaveAs (const NXString &partName, bool doSaveAs)
 Sets whether or not the non-master part specified will actually get saved during the save as operation.
virtual ~PartFromPartBuilder ()
 Free resources associated with the instance.

Detailed Description

This class provides the methods necessary to create a new part in NX Manager from an existing part.


The operation that this builder supports is equivalent to the file save as operation which can:

  1. Copy a non-master dataset into a previously existing item revision,
  2. Save a master dataset (and possibly non-master datasets) into a new revision of the same item,
  3. Save any master or non-master dataset as a completely new item.



The part that is saved is always the work part. If the save is successful, then the newly saved part will be the display part.


This class is a singleton meaning only one instance of it can be exist at a time.


Created in NX4.0.0.


Member Enumeration Documentation

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

Enumerator:
FileSaveAsSome 

save selected during save as

FileSaveAsAll 

save all during save as

FileSaveAsNone 

save none during save as


Constructor & Destructor Documentation

Free resources associated with the instance.

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

License requirements : None


Member Function Documentation

Creates the new part that has been fully-specified by calling methods on this builder.


Created in NX4.0.0.

License requirements : None

Initializes the list of non-master parts that can be saved during the save as operation.


Created in NX4.0.0.

License requirements : None

Returns the dependent files to save during the save as operation
Created in NX4.0.0.



License requirements : None

bool NXOpen::PDM::PartFromPartBuilder::EditNonmasterNameToSaveAs ( 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:
Whether or not the name is a valid data set name. The name will get set on the builder no matter if it is valid or not.
Created in NX4.0.0.

License requirements : None
Parameters:
oldNamethe non-master part whose save as name is being set here
NOTE: The full Unicode character set is not supported for this parameter.
newNamethe new name
NOTE: The full Unicode character set is not supported for this parameter.

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

Returns:
True means that this non-master will be saved. False means that this non-master will not be saved.
Created in NX4.0.0.

License requirements : None
Parameters:
partNamethe non-master part that the caller wants to save or not save
NOTE: The full Unicode character set is not supported for this parameter.

Returns the non-master parts to save during the save as operation
Created in NX4.0.0.



License requirements : None

Sets the dependent files to save during the save as operation
Created in NX4.0.0.



License requirements : None

Parameters:
saveOptionsave option

Sets the non-master parts to save during the save as operation
Created in NX4.0.0.



License requirements : None

Parameters:
saveOptionsave option
void NXOpen::PDM::PartFromPartBuilder::SetNonmasterToSaveAs ( const NXString partName,
bool  doSaveAs 
)

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 NX4.0.0.

License requirements : None

Parameters:
partNamethe non-master part whose save option is being set here
NOTE: The full Unicode character set is not supported for this parameter.
doSaveAsTrue means that this non-master part will be saved. False means that this non-master part will not be saved.

The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.