NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::PDM::PartOperationCreateBuilder Class Reference

Represents a builder class that performs Create operations
To create a new instance of this class, use NXOpen::PDM::PdmSession::CreateCreateOperationBuilder

Created in NX10.0.0. More...

Inheritance diagram for NXOpen::PDM::PartOperationCreateBuilder:
NXOpen::PDM::PartOperationBuilder NXOpen::Builder NXOpen::IAttributeSourceObjectBuilder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  OperationSubType { OperationSubTypeFromTemplate, OperationSubTypeSelectTemplate, OperationSubTypeRename, OperationSubTypeCreateSpecification }
 Represents an operation sub type for creating 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

bool GetAddMaster ()
 Returns logical value to indicate whether master to be added as child component. More...
 
NXOpen::PDM::PartOperationCreateBuilder::OperationSubType GetOperationSubType ()
 Returns the NXOpen::PDM::PartOperationCreateBuilder::OperationSubType for Create. More...
 
void SetAddMaster (bool addMaster)
 Sets the Add Master Flag Use this only in case creating a new Altrep. More...
 
void SetItemType (const NXString &itemType)
 Sets the selected Item Type
Created in NX10.0.0. More...
 
void SetItemType (const char *itemType)
 Sets the selected Item Type
Created in NX10.0.0. More...
 
void SetMasterPart (NXOpen::BasePart *masterPart)
 Sets the Master Part Use this only in case the part your are trying to create supports master model. More...
 
void SetModelType (const NXString &modelType)
 Sets the selected Model Type This is same as the Relation Type that is set by NXOpen::FileNew::RelationType and is same as the relation type specified in Template PAX files. More...
 
void SetModelType (const char *modelType)
 Sets the selected Model Type This is same as the Relation Type that is set by NXOpen::FileNew::RelationType and is same as the relation type specified in Template PAX files. More...
 
void SetOperationSubType (NXOpen::PDM::PartOperationCreateBuilder::OperationSubType operatioSubType)
 Sets the NXOpen::PDM::PartOperationCreateBuilder::OperationSubType for Create. More...
 
void SetPartSpecToOpen (const NXString &partSpecToOpen)
 Sets the Part Spec of the part to open in case of Select Template Dialog This is only applicable if NXOpen::PDM::PartOperationCreateBuilder::OperationSubType is set to NXOpen::PDM::PartOperationCreateBuilder::OperationSubTypeSelectTemplate partSpecTopOpen can be a CLI format (@DB/MFKID/RevId) or full TCIN file specification (starting with UGMGR) More...
 
void SetPartSpecToOpen (const char *partSpecToOpen)
 Sets the Part Spec of the part to open in case of Select Template Dialog This is only applicable if NXOpen::PDM::PartOperationCreateBuilder::OperationSubType is set to NXOpen::PDM::PartOperationCreateBuilder::OperationSubTypeSelectTemplate partSpecTopOpen can be a CLI format (@DB/MFKID/RevId) or full TCIN file specification (starting with UGMGR) More...
 
void SetPartsToRename (const std::vector< NXOpen::BasePart * > &partsToRename)
 Sets the Parts To Rename on the Builder. 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::ErrorListAutoAssignAttributes (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...
 
virtual NXOpen::ErrorListAutoAssignAttributesWithNamingPattern (const std::vector< NXOpen::NXObject * > &objects, const std::vector< NXOpen::NXObject * > &properties)
 Auto assigns the attributes for a given object and returns an array of objects that failed to auto assign. More...
 
void ClearWarnings ()
 Executes method ClearWarningCodeToLogicalObjectsSetMap() which clears m_warningCodeToLogicalObjectsSetMap. More...
 
virtual NXOpen::NXObjectCreateAttributeTitleToNamingPatternMap (std::vector< NXString > &attributeTitles, std::vector< NXString > &titlePatterns)
 Creates a map object of attribute titles to their corresponding naming pattern. 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::AlternateIdManagerGetAlternateIDManager (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::ErrorMessageHandlerGetErrorMessageHandler (bool refresh)
 Returns ErrorMessageHandler. More...
 
NXOpen::PDM::PartOperationBuilder::NonMasterSaveAs GetNonMasterCopyOption (NXOpen::PDM::LogicalObject *logicalObject)
 Get the nonmasters saveAs option for given logical object. More...
 
std::vector< NXStringGetNonMasterList (NXOpen::PDM::LogicalObject *logicalObject)
 Gets NonMaster list for the given logical Object. More...
 
NXOpen::ErrorListGetOperationFailures ()
 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::NXObjectCommit ()
 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::NXObjectGetObject ()
 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...
 

Detailed Description

Represents a builder class that performs Create operations
To create a new instance of this class, use NXOpen::PDM::PdmSession::CreateCreateOperationBuilder

Created in NX10.0.0.


Member Enumeration Documentation

Represents an operation sub type for creating a part.

Enumerator
OperationSubTypeFromTemplate 

Create New Part from template.

OperationSubTypeSelectTemplate 

Populate Part already created in Teamcenter.

OperationSubTypeRename 

Rename Existing Part.

OperationSubTypeCreateSpecification 

Create Specification and not a Part.

Member Function Documentation

bool NXOpen::PDM::PartOperationCreateBuilder::GetAddMaster ( )

Returns logical value to indicate whether master to be added as child component.

Returns
whether master to be added as child component
Created in NX10.0.0.

License requirements : None
NXOpen::PDM::PartOperationCreateBuilder::OperationSubType NXOpen::PDM::PartOperationCreateBuilder::GetOperationSubType ( )

Returns the NXOpen::PDM::PartOperationCreateBuilder::OperationSubType for Create.

Returns

Created in NX10.0.0.

License requirements : None
void NXOpen::PDM::PartOperationCreateBuilder::SetAddMaster ( bool  addMaster)

Sets the Add Master Flag Use this only in case creating a new Altrep.

This will add master as a component to newly created master. This will be set to false if tempalte selected doesn't supports creating new altrep.


Created in NX10.0.0.

License requirements : None

Parameters
addMasteraddmaster
void NXOpen::PDM::PartOperationCreateBuilder::SetItemType ( const NXString itemType)

Sets the selected Item Type
Created in NX10.0.0.



License requirements : None

Parameters
itemTypeitemtype
void NXOpen::PDM::PartOperationCreateBuilder::SetItemType ( const char *  itemType)

Sets the selected Item Type
Created in NX10.0.0.



License requirements : None

Parameters
itemTypeitemtype
void NXOpen::PDM::PartOperationCreateBuilder::SetMasterPart ( NXOpen::BasePart masterPart)

Sets the Master Part Use this only in case the part your are trying to create supports master model.


Created in NX10.0.0.

License requirements : None

Parameters
masterPartmasterpart
void NXOpen::PDM::PartOperationCreateBuilder::SetModelType ( const NXString modelType)

Sets the selected Model Type This is same as the Relation Type that is set by NXOpen::FileNew::RelationType and is same as the relation type specified in Template PAX files.

This is needed to be set only when the NXOpen::PDM::PartOperationCreateBuilder::OperationSubType is set to NXOpen::PDM::PartOperationCreateBuilder::OperationSubTypeCreateSpecification . In other cases this is read from the Template. If not set this is always assumed to be "master". Example strings are "specification", "manifestation", etc.


Created in NX10.0.0.

License requirements : None

Parameters
modelTypemodeltype
void NXOpen::PDM::PartOperationCreateBuilder::SetModelType ( const char *  modelType)

Sets the selected Model Type This is same as the Relation Type that is set by NXOpen::FileNew::RelationType and is same as the relation type specified in Template PAX files.

This is needed to be set only when the NXOpen::PDM::PartOperationCreateBuilder::OperationSubType is set to NXOpen::PDM::PartOperationCreateBuilder::OperationSubTypeCreateSpecification . In other cases this is read from the Template. If not set this is always assumed to be "master". Example strings are "specification", "manifestation", etc.


Created in NX10.0.0.

License requirements : None

Parameters
modelTypemodeltype
void NXOpen::PDM::PartOperationCreateBuilder::SetOperationSubType ( NXOpen::PDM::PartOperationCreateBuilder::OperationSubType  operatioSubType)

Sets the NXOpen::PDM::PartOperationCreateBuilder::OperationSubType for Create.


Created in NX10.0.0.

License requirements : None

Parameters
operatioSubTypeoperatiosubtype
void NXOpen::PDM::PartOperationCreateBuilder::SetPartSpecToOpen ( const NXString partSpecToOpen)

Sets the Part Spec of the part to open in case of Select Template Dialog This is only applicable if NXOpen::PDM::PartOperationCreateBuilder::OperationSubType is set to NXOpen::PDM::PartOperationCreateBuilder::OperationSubTypeSelectTemplate partSpecTopOpen can be a CLI format (@DB/MFKID/RevId) or full TCIN file specification (starting with UGMGR)


Created in NX10.0.0.

License requirements : None

Parameters
partSpecToOpenpartspectoopen
void NXOpen::PDM::PartOperationCreateBuilder::SetPartSpecToOpen ( const char *  partSpecToOpen)

Sets the Part Spec of the part to open in case of Select Template Dialog This is only applicable if NXOpen::PDM::PartOperationCreateBuilder::OperationSubType is set to NXOpen::PDM::PartOperationCreateBuilder::OperationSubTypeSelectTemplate partSpecTopOpen can be a CLI format (@DB/MFKID/RevId) or full TCIN file specification (starting with UGMGR)


Created in NX10.0.0.

License requirements : None

Parameters
partSpecToOpenpartspectoopen
void NXOpen::PDM::PartOperationCreateBuilder::SetPartsToRename ( const std::vector< NXOpen::BasePart * > &  partsToRename)

Sets the Parts To Rename on the Builder.

This is only applicable if NXOpen::PDM::PartOperationCreateBuilder::OperationSubType is set to NXOpen::PDM::PartOperationCreateBuilder::OperationSubTypeRename


Created in NX10.0.0.

License requirements : None

Parameters
partsToRenamepartstorename

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