NX Open C++ Reference Guide
|
Represents a builder class that performs various Save As operations. More...
Public Types | |
enum | CopyDependentFiles { CopyDependentFilesAll, CopyDependentFilesNone } |
This enum is used to specify which dependent files should be copied to new part during the save as operation. More... | |
enum | CopyNonMasterParts { CopyNonMasterPartsAll, CopyNonMasterPartsNone } |
This enum is used to specify which non-master parts should be copied to new part during the save as operation. More... | |
enum | OperationSubType { OperationSubTypeDefault, OperationSubTypeMakeUnique } |
Represents an operation sub type for copying a part. More... | |
Public Types inherited from NXOpen::PDM::PartOperationBuilder | |
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, OperationTypeCreate, OperationTypeImport } |
Represents an operation type that can be performed on a part Created in NX9.0.0. More... | |
Public Member Functions | |
void | AddRelatedPartsToCopy (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. More... | |
void | CreateNonMasterListForCopyLogicalObject (NXOpen::PDM::LogicalObject *logicalObject) |
Create NonMaster list for the selected logical Object Created in NX10.0.0. More... | |
NXOpen::PDM::PartOperationCopyBuilder::CopyDependentFiles | DependentFilesToCopyOption () |
Returns the Dependent files Save As option. More... | |
bool | EditNonMasterToCopyName (NXOpen::PDM::LogicalObject *logicalObject, const NXString &oldName, const NXString &newName) |
Sets the name the non-master part will get saved as. More... | |
bool | EditNonMasterToCopyName (NXOpen::PDM::LogicalObject *logicalObject, const char *oldName, const char *newName) |
Sets the name the non-master part will get saved as. More... | |
NXOpen::PDM::PartOperationCopyBuilder::CopyNonMasterParts | GetCopyNonMasterPartsOption (NXOpen::PDM::LogicalObject *logicalObject) |
Get the nonmasters saveAs option for given logical object. More... | |
std::vector< NXString > | GetNonMasterListForCopyLogicalObject (NXOpen::PDM::LogicalObject *logicalObject) |
Gets NonMaster list for the given logical Object. More... | |
NXOpen::PDM::PartOperationCopyBuilder::OperationSubType | GetOperationSubType () |
Returns the NXOpen::PDM::PartOperationCopyBuilder::OperationSubType for Create. More... | |
bool | IsNonMasterForLogicalObjectBeingCopied (NXOpen::PDM::LogicalObject *logicalObject, const NXString &partName) |
Returns whether or not the non-master part specified for the given NXOpen::PDM::LogicalObject will actually get saved during the save as operation. More... | |
bool | IsNonMasterForLogicalObjectBeingCopied (NXOpen::PDM::LogicalObject *logicalObject, const char *partName) |
Returns whether or not the non-master part specified for the given NXOpen::PDM::LogicalObject will actually get saved during the save as operation. More... | |
bool | ReplaceAllComponentsInSession () |
Returns the replace all components. More... | |
void | SetCopyNonMasterPartsOption (NXOpen::PDM::LogicalObject *logicalObject, NXOpen::PDM::PartOperationCopyBuilder::CopyNonMasterParts saveOption) |
Set the nonmasters saveAs option for given logical object. More... | |
void | SetDependentFilesToCopyOption (NXOpen::PDM::PartOperationCopyBuilder::CopyDependentFiles saveOption) |
Sets the Dependent files Save As option. More... | |
void | SetOperationSubType (NXOpen::PDM::PartOperationCopyBuilder::OperationSubType operationSubType) |
Sets the NXOpen::PDM::PartOperationCopyBuilder::OperationSubType for Create. More... | |
void | SetReplaceAllComponentsInSession (bool replaceAllComponents) |
Sets the replace all components. More... | |
void | SetSelectedNonMasterToCopy (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. More... | |
void | SetSelectedNonMasterToCopy (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. More... | |
void | SetSelectedPartsToCopy (const std::vector< NXOpen::BasePart * > &selectedParts, std::vector< NXOpen::BasePart * > &failedParts) |
Sets the selected parts. More... | |
Public Member Functions inherited from NXOpen::PDM::PartOperationBuilder | |
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. More... | |
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. More... | |
void | CreateLogicalObjects (std::vector< NXOpen::PDM::LogicalObject * > &logicalObjects) |
Creates the pre-creation objects for the parts Created in NX9.0.0. More... | |
void | CreateNonMasterListForLogicalObject (NXOpen::PDM::LogicalObject *logicalObject) |
Create NonMaster list for the selected logical Object More... | |
void | CreateSpecificationsForLogicalObjects (const std::vector< NXOpen::PDM::LogicalObject * > &logicalObjects) |
Create new specifications for Logical Objects Created in NX9.0.0. More... | |
NXString | DefaultDestinationFolder () |
Returns the default destination folder string for the part being created . More... | |
NXOpen::PDM::PartOperationBuilder::DependentFileSaveAs | DependentFileSaveAsOption () |
Returns the Dependent files Save As option. More... | |
bool | EditNonMasterName (NXOpen::PDM::LogicalObject *logicalObject, const NXString &oldName, const NXString &newName) |
Sets the name the non-master part will get saved as. More... | |
bool | EditNonMasterName (NXOpen::PDM::LogicalObject *logicalObject, const char *oldName, const char *newName) |
Sets the name the non-master part will get saved as. More... | |
NXOpen::PDM::AlternateIdManager * | GetAlternateIDManager (NXOpen::PDM::LogicalObject *logicalObject) |
Create an instance of a NXOpen::PDM::AlternateIdManager class that will be used to create alternate ID information while creating the new part. More... | |
NXOpen::PDM::PartOperationBuilder::OperationType | GetDialogOperation () |
Returns the dialog operation Applicable only for operation types PartOperationBuilder::OperationTypeSaveAs and PartOperationBuilder::OperationTypeRevise. More... | |
NXOpen::PDM::PartOperationBuilder::NonMasterSaveAs | GetNonMasterCopyOption (NXOpen::PDM::LogicalObject *logicalObject) |
Get the nonmasters saveAs option for given logical object. More... | |
std::vector< NXString > | GetNonMasterList (NXOpen::PDM::LogicalObject *logicalObject) |
Gets NonMaster list for the given logical Object. More... | |
NXOpen::ErrorList * | GetOperationFailures () |
Returns part operation failures. More... | |
bool | IsNonMasterBeingCopied (NXOpen::PDM::LogicalObject *logicalObject, const NXString &partName) |
Returns whether or not the non master part specified for the given NXOpen::PDM::LogicalObject will actually get saved during the save as operation. More... | |
bool | IsNonMasterBeingCopied (NXOpen::PDM::LogicalObject *logicalObject, const char *partName) |
Returns whether or not the non master part specified for the given NXOpen::PDM::LogicalObject will actually get saved during the save as operation. More... | |
bool | ReplaceAllComponents () |
Returns the replace all components. More... | |
void | SetDefaultDestinationFolder (const NXString &defaultDestinationFolder) |
Sets the default destination folder string for the part being created . More... | |
void | SetDefaultDestinationFolder (const char *defaultDestinationFolder) |
Sets the default destination folder string for the part being created . More... | |
void | SetDependentFileSaveAsOption (NXOpen::PDM::PartOperationBuilder::DependentFileSaveAs saveOption) |
Sets the Dependent files Save As option. More... | |
void | SetDialogOperation (NXOpen::PDM::PartOperationBuilder::OperationType dialogOperation) |
Sets the dialog operation. More... | |
void | SetNonMasterSaveAsOption (NXOpen::PDM::LogicalObject *logicalObject, NXOpen::PDM::PartOperationBuilder::NonMasterSaveAs saveOption) |
Set the nonmasters saveAs option for given logical object More... | |
void | SetReplaceAllComponents (bool replaceAllComponents) |
Sets the replace all components. More... | |
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. More... | |
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. More... | |
void | SetSelectedParts (const std::vector< NXOpen::BasePart * > &selectedParts, std::vector< NXOpen::BasePart * > &failedParts) |
Sets the selected parts. More... | |
void | ValidateLogicalObjectsToCommit () |
Validates NXOpen::PDM::LogicalObject objects with this builder and udpates the operation failuers. More... | |
Public Member Functions inherited from NXOpen::Builder | |
NXOpen::NXObject * | Commit () |
Commits any edits that have been applied to the builder. More... | |
void | Destroy () |
Deletes the builder, and cleans up any objects created by the builder. More... | |
std::vector< NXOpen::NXObject * > | GetCommittedObjects () |
For builders that create more than one object, this method returns the objects that are created by commit. More... | |
NXOpen::NXObject * | GetObject () |
Returns the object currently being edited by this builder. More... | |
void | ShowResults () |
Updates the model to reflect the result of an edit to the model for all builders that support showing results. More... | |
virtual bool | Validate () |
Validate whether the inputs to the component are sufficient for commit to be called. More... | |
Public Member Functions inherited from NXOpen::TaggedObject | |
tag_t | Tag () const |
Returns the tag of this object. More... | |
Represents a builder class that performs various Save As operations.
To create a new instance of this class, use NXOpen::PDM::PdmSession::CreateCopyOperationBuilder
Created in NX10.0.0.
void NXOpen::PDM::PartOperationCopyBuilder::AddRelatedPartsToCopy | ( | 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 NX10.0.0.
License requirements : None
basePart | basepart |
relatedParts | relatedparts |
relatedPartsReasons | relatedpartsreasons |
operation | operation |
void NXOpen::PDM::PartOperationCopyBuilder::CreateNonMasterListForCopyLogicalObject | ( | NXOpen::PDM::LogicalObject * | logicalObject | ) |
Create NonMaster list for the selected logical Object
Created in NX10.0.0.
License requirements : None
logicalObject | logicalobject |
NXOpen::PDM::PartOperationCopyBuilder::CopyDependentFiles NXOpen::PDM::PartOperationCopyBuilder::DependentFilesToCopyOption | ( | ) |
Returns the Dependent files Save As option.
Save As option can be one of these PartOperationCopyBuilder::CopyDependentFilesAll and PartOperationCopyBuilder::CopyDependentFilesNone
Created in NX10.0.0.
License requirements : None
bool NXOpen::PDM::PartOperationCopyBuilder::EditNonMasterToCopyName | ( | 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.
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::PartOperationCopyBuilder::EditNonMasterToCopyName | ( | 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.
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::PartOperationCopyBuilder::CopyNonMasterParts NXOpen::PDM::PartOperationCopyBuilder::GetCopyNonMasterPartsOption | ( | NXOpen::PDM::LogicalObject * | logicalObject | ) |
Get the nonmasters saveAs option for given logical object.
Save As option can be one of these PartOperationCopyBuilder::CopyNonMasterPartsAll and PartOperationCopyBuilder::CopyNonMasterPartsNone
logicalObject | logicalobject |
std::vector<NXString> NXOpen::PDM::PartOperationCopyBuilder::GetNonMasterListForCopyLogicalObject | ( | NXOpen::PDM::LogicalObject * | logicalObject | ) |
Gets NonMaster list for the given logical Object.
logicalObject | logicalobject |
NXOpen::PDM::PartOperationCopyBuilder::OperationSubType NXOpen::PDM::PartOperationCopyBuilder::GetOperationSubType | ( | ) |
Returns the NXOpen::PDM::PartOperationCopyBuilder::OperationSubType for Create.
bool NXOpen::PDM::PartOperationCopyBuilder::IsNonMasterForLogicalObjectBeingCopied | ( | NXOpen::PDM::LogicalObject * | logicalObject, |
const NXString & | partName | ||
) |
Returns whether or not the non-master part specified for the given NXOpen::PDM::LogicalObject will actually get saved during the save as operation.
logicalObject | logicalobject |
partName | the non-master part that the caller wants to save or not save NOTE: The full Unicode character set is not supported for this parameter. |
bool NXOpen::PDM::PartOperationCopyBuilder::IsNonMasterForLogicalObjectBeingCopied | ( | NXOpen::PDM::LogicalObject * | logicalObject, |
const char * | partName | ||
) |
Returns whether or not the non-master part specified for the given NXOpen::PDM::LogicalObject will actually get saved during the save as operation.
logicalObject | logicalobject |
partName | the non-master part that the caller wants to save or not save NOTE: The full Unicode character set is not supported for this parameter. |
bool NXOpen::PDM::PartOperationCopyBuilder::ReplaceAllComponentsInSession | ( | ) |
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 NX10.0.0.
License requirements : None
void NXOpen::PDM::PartOperationCopyBuilder::SetCopyNonMasterPartsOption | ( | NXOpen::PDM::LogicalObject * | logicalObject, |
NXOpen::PDM::PartOperationCopyBuilder::CopyNonMasterParts | saveOption | ||
) |
Set the nonmasters saveAs option for given logical object.
Save As option can be one of these PartOperationCopyBuilder::CopyNonMasterPartsAll and PartOperationCopyBuilder::CopyNonMasterPartsNone
Created in NX10.0.0.
License requirements : None
logicalObject | logicalobject |
saveOption | saveoption |
void NXOpen::PDM::PartOperationCopyBuilder::SetDependentFilesToCopyOption | ( | NXOpen::PDM::PartOperationCopyBuilder::CopyDependentFiles | saveOption | ) |
Sets the Dependent files Save As option.
Save As option can be one of these PartOperationCopyBuilder::CopyDependentFilesAll and PartOperationCopyBuilder::CopyDependentFilesNone
Created in NX10.0.0.
License requirements : None
saveOption | saveoption |
void NXOpen::PDM::PartOperationCopyBuilder::SetOperationSubType | ( | NXOpen::PDM::PartOperationCopyBuilder::OperationSubType | operationSubType | ) |
Sets the NXOpen::PDM::PartOperationCopyBuilder::OperationSubType for Create.
Created in NX10.0.0.
License requirements : None
operationSubType | operationsubtype |
void NXOpen::PDM::PartOperationCopyBuilder::SetReplaceAllComponentsInSession | ( | 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 NX10.0.0.
License requirements : None
replaceAllComponents | replaceallcomponents |
void NXOpen::PDM::PartOperationCopyBuilder::SetSelectedNonMasterToCopy | ( | 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 NX10.0.0.
License requirements : None
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::PartOperationCopyBuilder::SetSelectedNonMasterToCopy | ( | 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 NX10.0.0.
License requirements : None
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::PartOperationCopyBuilder::SetSelectedPartsToCopy | ( | 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. NXOpen::PDM::PartOperationBuilder::GetOperationFailures can be called to get the errors occurred during this operation.
Created in NX10.0.0.
License requirements : None
selectedParts | selectedparts |
failedParts | failedparts |