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

This class serves as the base class for NX Manager part builders. More...

Inheritance diagram for NXOpen.PDM.PartBuilder:
NXOpen.TransientObject NXOpen.Utilities.NXRemotableObject IDisposable IMessageSink NXOpen.PDM.PartFromPartBuilder NXOpen.PDM.PartFromTemplateBuilder

Classes

struct  _PartFileNameData
 Contains part file name information
 
struct  _PartNumberData
 Contains part number information.
 
struct  _PartRevisionData
 Contains part revision information
 
struct  PartFileNameData
 Contains part file name information More...
 
struct  PartNumberData
 Contains part number information. More...
 
struct  PartRevisionData
 Contains part revision information More...
 

Public Types

enum  Operation { ExportPartNew, AssemblyDiagram, AssemblyCreateNewComponent, Default }
 Tokens identifying every possible UG/Manager part selection dialog. More...
 

Public Member Functions

unsafe string AssignPartFileName (string partFileType)
 This method generates a part file name given an input part file type and assigns this part file name to the builder. More...
 
unsafe
NXOpen.PDM.PartBuilder.PartFileNameData 
AssignPartFileName (string partNumber, string partRevision, string partFileNameType, string oldPartFileName)
 This method generates a part file name and assigns this part file name to the builder. More...
 
unsafe string AssignPartNumber (string partType)
 This method generates a part number given an input part type and assigns this part number to the builder. More...
 
unsafe
NXOpen.PDM.PartBuilder.PartNumberData 
AssignPartNumber (string oldPartNumber, string partType)
 This method generates a part number given an input part type and sets this part number to the builder. More...
 
unsafe string AssignPartRevision ()
 This method generates a part revision and assigns this part revision to the builder. More...
 
unsafe
NXOpen.PDM.PartBuilder.PartRevisionData 
AssignPartRevision (int overload)
 This method generates a part revision and sets this part revision to the builder. More...
 
unsafe
NXOpen.PDM.PartCreationObject 
CreatePartCreationObject ()
 Create an instance of a NXOpen.PDM.PartCreationObject class that acts as a proxy for a part in NX Manager mode prior to that part being created. More...
 
unsafe void CreatePartSpec (string partType, string partNumber, string partRevision, string partFileType, string partFileName)
 Create the specification for the new part that will be created. More...
 
unsafe
NXOpen.PDM.AlternateIdManager 
NewAlternateIdManager ()
 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.DatabaseAttributeManager 
NewDatabaseAttributeManager ()
 Create an instance of a NXOpen.PDM.DatabaseAttributeManager class that will be used to modify database attributes while creating the new part. More...
 
unsafe void SetAssignPartNumber (string partNumber)
 Sets the part number explicitly into builder. More...
 
unsafe void SetAssignPartType (string partType)
 Sets the part type explicitly into builder. More...
 
unsafe void SetContextOperation (NXOpen.PDM.PartBuilder.Operation operation)
 Sets explicitly the place from where part selection dialog invoked into builder. More...
 
- Public Member Functions inherited from NXOpen.TransientObject
void Dispose ()
 Frees the object from memory. More...
 
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
new 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...
 

Protected Member Functions

override void FreeResource ()
 Free resources associated with the instance. More...
 

Additional Inherited Members

- Properties inherited from NXOpen.TransientObject
IntPtr Handle [get]
 Handle of the internal object represented by this object. More...
 

Detailed Description

This class serves as the base class for NX Manager part builders.

The NX Manager part builders are used to create new parts in NX Manager mode.

This class is deprecated in NX10 for "Create" and "Save As of master parts" operations. This class should only be used in case of Save As Non Master parts and Save As New Item Type Operations. For Create of all parts use NXOpen.PDM.PartOperationBuilder and NXOpen.FileNew For Save As of master parts, use NXOpen.PDM.PartOperationCopyBuilder .

This is an abstract class, and cannot be created.

Created in NX4.0.0

Member Enumeration Documentation

Tokens identifying every possible UG/Manager part selection dialog.

Enumerator
ExportPartNew 

File->Export->NXOpen.Part:New radio button

AssemblyDiagram 

Assembly->Report->Assembly Diagram...

AssemblyCreateNewComponent 

Assembly->NXOpen.Assemblies.Component->Create New...

Default 

Default UG/Manager part selection dialog

Member Function Documentation

unsafe string NXOpen.PDM.PartBuilder.AssignPartFileName ( string  partFileType)
inline

This method generates a part file name given an input part file type and assigns this part file name to the builder.

This method depends on the part type, part number, and part revision already being set on the builder. Therefore, a call to PDM.PartBuilder.CreatePartSpec or, more likely, calls to PDM.PartBuilder.AssignPartNumber and PDM.PartBuilder.AssignPartRevision must be made before calling this method.

If this method is called before PDM.PartBuilder.CreatePartSpec (as will typically be the case) then the part_file_type and part_file_name parameters of PDM.PartBuilder.CreatePartSpec should be set to a null reference (Nothing in Visual Basic) so that the builder will use the values assigned by this method. Otherwise, CreatePartSpec will override the values assigned here and assign the values of the part_file_type and part_file_name parameters to the builder.

Deprecated in NX10 except for Save As Non Master part and Save As to New Item Type operations. Use NXOpen.PDM.PartOperationBuilder.CreateSpecificationsForLogicalObjects instead.

Created in NX4.0.0

License requirements: None.

Parameters
partFileTypethe part file type. Note that if the part file type is "master", then this method will return a null reference (Nothing in Visual Basic) but will still set the part file type in the builder.
Returns
the assigned part file name
unsafe NXOpen.PDM.PartBuilder.PartFileNameData NXOpen.PDM.PartBuilder.AssignPartFileName ( string  partNumber,
string  partRevision,
string  partFileNameType,
string  oldPartFileName 
)
inline

This method generates a part file name and assigns this part file name to the builder.

If this method is called before PDM.PartBuilder.CreatePartSpec then the part_file_name parameter of PDM.PartBuilder.CreatePartSpec should be set to a null reference (Nothing in Visual Basic) so that the builder will use the value assigned by this method. Otherwise, CreatePartSpec will override the value assigned here and assign the values of the part_file_type and part_file_name parameters to the builder.

Deprecated in NX10 except for Save As Non Master part and Save As to New Item Type operations. Use NXOpen.PDM.PartOperationBuilder.CreateSpecificationsForLogicalObjects instead.

Created in NX5.0.0

License requirements: None.

Parameters
partNumberPart Number
partRevisionpart revision
partFileNameTypePart file name type. Note that if the part file type is "master", then this method will set the field PartFileName of PDM.PartBuilder.PartFileNameData with a null reference (Nothing in Visual Basic)
oldPartFileNameOld part file name
Returns
unsafe string NXOpen.PDM.PartBuilder.AssignPartNumber ( string  partType)
inline

This method generates a part number given an input part type and assigns this part number to the builder.

The input part type will also be assigned to the builder. If the input part type is a null reference (Nothing in Visual Basic) then this method will fail unless the part type has already been set on the builder via a previous call to this method or to PDM.PartBuilder.CreatePartSpec .

If this method is called before PDM.PartBuilder.CreatePartSpec (as will typically be the case) then the part_type and part_number parameters of PDM.PartBuilder.CreatePartSpec should be set to a null reference (Nothing in Visual Basic) so that the builder will use the values assigned by this method. Otherwise, CreatePartSpec will override the values assigned here and assign the values of the part_type and part_number parameters to the builder.

The output part_number: In case of Default Domain: it is Teamcenter item ID. In case of non-Default Domain: it is the multifield key. e.g. %MFK#%,=item_id=001, object_type=SupplierPart, supplier_code=x

Deprecated in NX10 except for Save As Non Master part and Save As to New Item Type operations. Use NXOpen.PDM.PartOperationCreateBuilder for Create and NXOpen.PDM.PartOperationCopyBuilder for Save As instead. To assign part number, use NXOpen.PDM.LogicalObject and NXOpen.AttributePropertiesBuilder to create DB_PART_NO attribute.

Created in NX4.0.0

License requirements: None.

Parameters
partTypethe part type
Returns
the assigned multifield key
unsafe NXOpen.PDM.PartBuilder.PartNumberData NXOpen.PDM.PartBuilder.AssignPartNumber ( string  oldPartNumber,
string  partType 
)
inline

This method generates a part number given an input part type and sets this part number to the builder.

The input part type will also be assigned to the builder. If the input part type is a null reference (Nothing in Visual Basic) then this method will fail unless the part type has already been set on the builder via a previous call to this method or to PDM.PartBuilder.CreatePartSpec .

If this overloaded method is called before PDM.PartBuilder.CreatePartSpec then the part_number parameter of PDM.PartBuilder.CreatePartSpec should be set to a null reference (Nothing in Visual Basic) so that the builder will use the value assigned by this method. Otherwise, CreatePartSpec will override the value assigned here and assign the value of part_number parameter to the builder.

The output part_number in part_info structure: In case of Default Domain: it is Teamcenter item ID. In case of non-Default Domain: it is the multifield key. e.g. %MFK#%,=item_id=001, object_type=SupplierPart, supplier_code=x

Deprecated in NX10 except for Save As Non Master part and Save As to New Item Type operations. Use NXOpen.PDM.PartOperationCreateBuilder for Create and NXOpen.PDM.PartOperationCopyBuilder for Save As instead. To assign part number, use NXOpen.PDM.LogicalObject and NXOpen.AttributePropertiesBuilder to create DB_PART_NO attribute.

Created in NX5.0.0

License requirements: None.

Parameters
oldPartNumberOld part number
partTypePart type
Returns
Contains part number information.
unsafe string NXOpen.PDM.PartBuilder.AssignPartRevision ( )
inline

This method generates a part revision and assigns this part revision to the builder.

This method depends on the part type and part number already being set on the builder. Therefore, a call to PDM.PartBuilder.CreatePartSpec or, more likely, to AssignPartNumber must be made before calling this method.

If this method is called before PDM.PartBuilder.CreatePartSpec (as will typically be the case) then the part_revision parameter of PDM.PartBuilder.CreatePartSpec should be set to a null reference (Nothing in Visual Basic) so that the builder will use the value assigned by this method. Otherwise, CreatePartSpec will override the value assigned here and assign the value of the part_revision parameters to the builder.

Deprecated in NX10 except for Save As Non Master part and Save As to New Item Type operations. Use NXOpen.PDM.PartOperationCreateBuilder for Create and NXOpen.PDM.PartOperationCopyBuilder for Save As instead. To assign part number, use NXOpen.PDM.LogicalObject and NXOpen.AttributePropertiesBuilder to create DB_PART_REV attribute.

Created in NX4.0.0

License requirements: None.

Returns
the assigned part revision
unsafe NXOpen.PDM.PartBuilder.PartRevisionData NXOpen.PDM.PartBuilder.AssignPartRevision ( int  overload)
inline

This method generates a part revision and sets this part revision to the builder.

This method depends on the part type and part number already being set on the builder. Therefore, a call to PDM.PartBuilder.CreatePartSpec or, more likely, to AssignPartNumber must be made before calling this method.

If this method is called before PDM.PartBuilder.CreatePartSpec then the part_revision parameter of PDM.PartBuilder.CreatePartSpec should be set to a null reference (Nothing in Visual Basic) so that the builder will use the value assigned by this method. Otherwise, CreatePartSpec will override the value assigned here and assign the value of the part_revision parameters to the builder.

Deprecated in NX10 except for Save As Non Master part and Save As to New Item Type operations. Use NXOpen.PDM.PartOperationCreateBuilder for Create and NXOpen.PDM.PartOperationCopyBuilder for Save As instead. To assign part number, use NXOpen.PDM.LogicalObject and NXOpen.AttributePropertiesBuilder to create DB_PART_REV attribute.

Created in NX5.0.0

License requirements: None.

Parameters
overloadDummy parameter to call this overloaded method
Returns
Contains part revision information
unsafe NXOpen.PDM.PartCreationObject NXOpen.PDM.PartBuilder.CreatePartCreationObject ( )
inline

Create an instance of a NXOpen.PDM.PartCreationObject class that acts as a proxy for a part in NX Manager mode prior to that part being created.

Created in NX8.0.0

License requirements: None.

Returns
the new NXOpen.PDM.PartCreationObject instance
unsafe void NXOpen.PDM.PartBuilder.CreatePartSpec ( string  partType,
string  partNumber,
string  partRevision,
string  partFileType,
string  partFileName 
)
inline

Create the specification for the new part that will be created.

For the input part_number: In case of Default Domain: it is Teamcenter item ID. In case of non-Default Domain: it is the multifield key. e.g. %MFK#%,=item_id=001, object_type=SupplierPart, supplier_code=x And the encoded part filename would be containing the MFK.

NOTE: The part_file_name argument is the Dataset Name and is applicable only while creating specs for non-master parts.

Deprecated in NX10 except for Save As Non Master part and Save As to New Item Type operations. Use NXOpen.PDM.PartOperationBuilder.CreateSpecificationsForLogicalObjects instead.

Created in NX4.0.0

License requirements: None.

Parameters
partTypethe part type
partNumberthe multifield key
partRevisionthe part revision
partFileTypethe part file type
partFileNamethe dataset name
override void NXOpen.PDM.PartBuilder.FreeResource ( )
inlineprotectedvirtual

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.

Implements NXOpen.TransientObject.

Reimplemented in NXOpen.PDM.PartFromPartBuilder, and NXOpen.PDM.PartFromTemplateBuilder.

unsafe NXOpen.PDM.AlternateIdManager NXOpen.PDM.PartBuilder.NewAlternateIdManager ( )
inline

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

Created in NX4.0.0

License requirements: None.

Returns
the new NXOpen.PDM.AlternateIdManager instance
unsafe NXOpen.PDM.DatabaseAttributeManager NXOpen.PDM.PartBuilder.NewDatabaseAttributeManager ( )
inline

Create an instance of a NXOpen.PDM.DatabaseAttributeManager class that will be used to modify database attributes while creating the new part.

Created in NX4.0.0

License requirements: None.

Returns
the new NXOpen.PDM.DatabaseAttributeManager instance
unsafe void NXOpen.PDM.PartBuilder.SetAssignPartNumber ( string  partNumber)
inline

Sets the part number explicitly into builder.

This method is called before PDM.PartBuilder.CreatePartSpec

Deprecated in NX10 except for Save As Non Master part and Save As to New Item Type operations. Use NXOpen.PDM.PartOperationCreateBuilder for Create and NXOpen.PDM.PartOperationCopyBuilder for Save As instead. To assign part number, use NXOpen.PDM.LogicalObject and NXOpen.AttributePropertiesBuilder to set the DB_PART_NO attribute.

Created in NX5.0.0

License requirements: None.

Parameters
partNumberthe part number
unsafe void NXOpen.PDM.PartBuilder.SetAssignPartType ( string  partType)
inline

Sets the part type explicitly into builder.

This method is called before PDM.PartBuilder.CreatePartSpec

Deprecated in NX10 except for Save As Non Master part and Save As to New Item Type operations. Use NXOpen.PDM.PartOperationBuilder.CreateSpecificationsForLogicalObjects instead.

Created in NX5.0.0

License requirements: None.

Parameters
partType
unsafe void NXOpen.PDM.PartBuilder.SetContextOperation ( NXOpen.PDM.PartBuilder.Operation  operation)
inline

Sets explicitly the place from where part selection dialog invoked into builder.

Deprecated in NX10 except for Save As Non Master part and Save As to New Item Type operations. Use NXOpen.PDM.PartOperationBuilder.CreateSpecificationsForLogicalObjects instead.

Created in NX5.0.0

License requirements: None.

Parameters
operationToken identifying place from where UG/Manager part selection dialog invoked

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