NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | List of all members
NXOpen.PDM.PartOperationCreateBuilder Class Reference

Represents a builder class that performs Create operations More...

Inheritance diagram for NXOpen.PDM.PartOperationCreateBuilder:
NXOpen.PDM.PartOperationBuilder NXOpen.Builder NXOpen.IAttributeSourceObjectBuilder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  OperationSubType { FromTemplate, SelectTemplate, Rename, CreateSpecification }
 Represents an operation sub type for creating a part More...
 
- Public Types inherited from NXOpen.PDM.PartOperationBuilder
enum  DependentFileSaveAs { All, None }
 This enum is used to specify which dependent files should be saved during the save as operation. More...
 
enum  NonMasterSaveAs { All, None }
 This enum is used to specify which non-master parts should be saved during the save as operation. More...
 
enum  OperationType { SaveAs, Revise, Create, Import }
 Represents an operation type that can be performed on a part More...
 

Public Member Functions

unsafe bool GetAddMaster ()
 Returns logical value to indicate whether master to be added as child component More...
 
unsafe
NXOpen.PDM.PartOperationCreateBuilder.OperationSubType 
GetOperationSubType ()
 Returns the NXOpen.PDM.PartOperationCreateBuilder.OperationSubType for Create. More...
 
unsafe void SetAddMaster (bool addMaster)
 Sets the Add Master Flag Use this only in case creating a new Altrep. More...
 
unsafe void SetItemType (string itemType)
 Sets the selected Item Type More...
 
unsafe 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...
 
unsafe void SetModelType (string 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...
 
unsafe void SetOperationSubType (NXOpen.PDM.PartOperationCreateBuilder.OperationSubType operatioSubType)
 Sets the NXOpen.PDM.PartOperationCreateBuilder.OperationSubType for Create. More...
 
unsafe void SetPartSpecToOpen (string 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.OperationSubType.SelectTemplate partSpecTopOpen can be a CLI format (/MFKID/RevId) or full TCIN file specification (starting with UGMGR) More...
 
unsafe void SetPartsToRename (NXOpen.BasePart[] partsToRename)
 Sets the Parts To Rename on the Builder. More...
 
- Public Member Functions inherited from NXOpen.PDM.PartOperationBuilder
unsafe void AddRelatedPartToOperate (NXOpen.BasePart basePart, NXOpen.BasePart[] relatedParts, string[] relatedPartsReasons, NXOpen.PDM.PartOperationBuilder.OperationType operation)
 Add related part to the part undergoing an operation. More...
 
unsafe NXOpen.ErrorList AutoAssignAttributes (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...
 
unsafe NXOpen.ErrorList AutoAssignAttributesWithNamingPattern (NXOpen.NXObject[] objects, NXOpen.NXObject[] properties)
 Auto assigns the attributes for a given object and returns an array of objects that failed to auto assign. More...
 
unsafe void ClearWarnings ()
 Executes method ClearWarningCodeToLogicalObjectsSetMap() which clears m_warningCodeToLogicalObjectsSetMap More...
 
unsafe NXOpen.NXObject CreateAttributeTitleToNamingPatternMap (string[] attributeTitles, string[] titlePatterns)
 Creates a map object of attribute titles to their corresponding naming pattern More...
 
unsafe void CreateLogicalObjects (out NXOpen.PDM.LogicalObject[] logicalObjects)
 Creates the pre-creation objects for the parts More...
 
unsafe void CreateNonMasterListForLogicalObject (NXOpen.PDM.LogicalObject logicalObject)
 Create NonMaster list for the selected logical Object More...
 
unsafe void CreateSpecificationsForLogicalObjects (NXOpen.PDM.LogicalObject[] logicalObjects)
 Create new specifications for Logical Objects More...
 
unsafe bool EditNonMasterName (NXOpen.PDM.LogicalObject logicalObject, string oldName, string newName)
 Sets the name the non-master part will get saved as. More...
 
unsafe
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...
 
unsafe
NXOpen.PDM.PartOperationBuilder.OperationType 
GetDialogOperation ()
 Returns the dialog operation Applicable only for operation types PartOperationBuilder.OperationType.SaveAs and PartOperationBuilder.OperationType.Revise More...
 
unsafe
NXOpen.PDM.ErrorMessageHandler 
GetErrorMessageHandler (bool refresh)
 Returns ErrorMessageHandler More...
 
unsafe
NXOpen.PDM.PartOperationBuilder.NonMasterSaveAs 
GetNonMasterCopyOption (NXOpen.PDM.LogicalObject logicalObject)
 Get the nonmasters saveAs option for given logical object. More...
 
unsafe string[] GetNonMasterList (NXOpen.PDM.LogicalObject logicalObject)
 Gets NonMaster list for the given logical Object More...
 
unsafe NXOpen.ErrorList GetOperationFailures ()
 Returns part operation failures More...
 
unsafe bool IsNonMasterBeingCopied (NXOpen.PDM.LogicalObject logicalObject, string 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...
 
unsafe void SetDialogOperation (NXOpen.PDM.PartOperationBuilder.OperationType dialogOperation)
 Sets the dialog operation. More...
 
unsafe void SetNonMasterSaveAsOption (NXOpen.PDM.LogicalObject logicalObject, NXOpen.PDM.PartOperationBuilder.NonMasterSaveAs saveOption)
 Set the nonmasters saveAs option for given logical object More...
 
unsafe void SetSelectedNonMasterToSaveAs (NXOpen.PDM.LogicalObject logicalObject, string partName)
 Sets whether or not the non-master part specified will actually get saved during the save as operation. More...
 
unsafe void SetSelectedParts (NXOpen.BasePart[] selectedParts, out NXOpen.BasePart[] failedParts)
 Sets the selected parts. More...
 
unsafe void ValidateLogicalObjectsToCommit ()
 Validates NXOpen.PDM.LogicalObject objects with this builder and udpates the operation failuers. More...
 
- Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject Commit ()
 Commits any edits that have been applied to the builder. More...
 
unsafe void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
unsafe NXOpen.NXObject[] GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
unsafe NXOpen.NXObject GetObject ()
 Returns the object currently being edited by this builder. More...
 
unsafe void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 
- Properties inherited from NXOpen.PDM.PartOperationBuilder
unsafe string DefaultDestinationFolder [get, set]
 Returns or sets the default destination folder string for the part being created . More...
 
unsafe
NXOpen.PDM.PartOperationBuilder.DependentFileSaveAs 
DependentFileSaveAsOption [get, set]
 Returns or sets the Dependent files Save As option. More...
 
unsafe bool ReplaceAllComponents [get, set]
 Returns or sets the replace all components. 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
FromTemplate 

Create New Part from template

SelectTemplate 

Populate Part already created in Teamcenter

Rename 

Rename Existing Part

CreateSpecification 

Create Specification and not a Part

Member Function Documentation

unsafe bool NXOpen.PDM.PartOperationCreateBuilder.GetAddMaster ( )
inline

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

Created in NX10.0.0

License requirements: None.

Returns
whether master to be added as child component
unsafe NXOpen.PDM.PartOperationCreateBuilder.OperationSubType NXOpen.PDM.PartOperationCreateBuilder.GetOperationSubType ( )
inline

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

Created in NX10.0.0

License requirements: None.

Returns
unsafe void NXOpen.PDM.PartOperationCreateBuilder.SetAddMaster ( bool  addMaster)
inline

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
addMaster
unsafe void NXOpen.PDM.PartOperationCreateBuilder.SetItemType ( string  itemType)
inline

Sets the selected Item Type

Created in NX10.0.0

License requirements: None.

Parameters
itemType
unsafe void NXOpen.PDM.PartOperationCreateBuilder.SetMasterPart ( NXOpen.BasePart  masterPart)
inline

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
masterPart
unsafe void NXOpen.PDM.PartOperationCreateBuilder.SetModelType ( string  modelType)
inline

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.OperationSubType.CreateSpecification . 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
modelType
unsafe void NXOpen.PDM.PartOperationCreateBuilder.SetOperationSubType ( NXOpen.PDM.PartOperationCreateBuilder.OperationSubType  operatioSubType)
inline

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

Created in NX10.0.0

License requirements: None.

Parameters
operatioSubType
unsafe void NXOpen.PDM.PartOperationCreateBuilder.SetPartSpecToOpen ( string  partSpecToOpen)
inline

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.OperationSubType.SelectTemplate partSpecTopOpen can be a CLI format (/MFKID/RevId) or full TCIN file specification (starting with UGMGR)

Created in NX10.0.0

License requirements: None.

Parameters
partSpecToOpen
unsafe void NXOpen.PDM.PartOperationCreateBuilder.SetPartsToRename ( NXOpen.BasePart[]  partsToRename)
inline

Sets the Parts To Rename on the Builder.

This is only applicable if NXOpen.PDM.PartOperationCreateBuilder.OperationSubType is set to NXOpen.PDM.PartOperationCreateBuilder.OperationSubType.Rename

Created in NX10.0.0

License requirements: None.

Parameters
partsToRename

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