NX Open C++ Reference Guide
Classes | Public Types | Public Member Functions
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::PDM::PartFromPartBuilder NXOpen::PDM::PartFromTemplateBuilder

List of all members.

Classes

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 { OperationExportPartNew, OperationAssemblyDiagram, OperationAssemblyCreateNewComponent, OperationDefault }
 Tokens identifying every possible UG/Manager part selection dialog. More...

Public Member Functions

NXString AssignPartFileName (const NXString &partFileType)
 This method generates a part file name given an input part file type and assigns this part file name to the builder.
NXOpen::PDM::PartBuilder::PartFileNameData AssignPartFileName (const NXString &partNumber, const NXString &partRevision, const NXString &partFileNameType, const NXString &oldPartFileName)
 This method generates a part file name and assigns this part file name to the builder.
NXString AssignPartNumber (const NXString &partType)
 This method generates a part number given an input part type and assigns this part number to the builder.
NXOpen::PDM::PartBuilder::PartNumberData AssignPartNumber (const NXString &oldPartNumber, const NXString &partType)
 This method generates a part number given an input part type and sets this part number to the builder.
NXString AssignPartRevision ()
 This method generates a part revision and assigns this part revision to the builder.
NXOpen::PDM::PartBuilder::PartRevisionData AssignPartRevision (int overload)
 This method generates a part revision and sets this part number to the builder.
NXOpen::PDM::PartCreationObjectCreatePartCreationObject ()
 Create an instance of a PDM::PartCreationObject class that acts as a proxy for a part in NX Manager mode prior to that part being created.
void CreatePartSpec (const NXString &partType, const NXString &partNumber, const NXString &partRevision, const NXString &partFileType, const NXString &partFileName)
 Create the specification for the new part that will be created.
NXOpen::PDM::AlternateIdManagerNewAlternateIdManager ()
 Create an instance of a PDM::AlternateIdManager class that will be used to create alternate ID information while creating the new part.
NXOpen::PDM::DatabaseAttributeManagerNewDatabaseAttributeManager ()
 Create an instance of a PDM::DatabaseAttributeManager class that will be used to modify database attributes while creating the new part.
void SetAssignPartNumber (const NXString &partNumber)
 Sets the part number explicitly into builder.
void SetAssignPartType (const NXString &partType)
 Sets the part type explicitly into builder.
void SetContextOperation (NXOpen::PDM::PartBuilder::Operation operation)
 Sets explicitly the place from where part selection dialog invoked into builder.
virtual ~PartBuilder ()
 Free resources associated with the instance.

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 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:
OperationExportPartNew 

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

OperationAssemblyDiagram 

Assembly->Report->Assembly Diagram...

OperationAssemblyCreateNewComponent 

Assembly->Component->Create New...

OperationDefault 

Default UG/Manager part selection dialog.


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

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 NULL 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.

Returns:
the assigned part file name
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 NULL but will still set the part file type in the builder.
NOTE: The full Unicode character set is not supported for this parameter.
NXOpen::PDM::PartBuilder::PartFileNameData NXOpen::PDM::PartBuilder::AssignPartFileName ( const NXString partNumber,
const NXString partRevision,
const NXString partFileNameType,
const NXString oldPartFileName 
)

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 NULL 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.

Returns:

Created in NX5.0.0.

License requirements : None
Parameters:
partNumberPart Number
NOTE: The full Unicode character set is not supported for this parameter.
partRevisionpart revision
NOTE: The full Unicode character set is not supported for this parameter.
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 NULL
NOTE: The full Unicode character set is not supported for this parameter.
oldPartFileNameOld part file name
NOTE: The full Unicode character set is not supported for this parameter.

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 NULL 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 NULL 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.

Returns:
the assigned part number
Created in NX4.0.0.

License requirements : None
Parameters:
partTypethe part type
NOTE: The full Unicode character set is not supported for this parameter.

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 NULL 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 NULL 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.

Returns:
Contains part number information.
Created in NX5.0.0.

License requirements : None
Parameters:
oldPartNumberOld part number
NOTE: The full Unicode character set is not supported for this parameter.
partTypePart type
NOTE: The full Unicode character set is not supported for this parameter.

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 NULL 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.

Returns:
the assigned part revision
Created in NX4.0.0.

License requirements : None

This method generates a part revision and sets this part number 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 NULL 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.

Returns:
Contains part revision information
Created in NX5.0.0.

License requirements : None
Parameters:
overloadDummy parameter to call this overloaded method

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

Returns:
the new PDM::PartCreationObject instance
Created in NX8.0.0.

License requirements : None
void NXOpen::PDM::PartBuilder::CreatePartSpec ( const NXString partType,
const NXString partNumber,
const NXString partRevision,
const NXString partFileType,
const NXString partFileName 
)

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


Created in NX4.0.0.

License requirements : None

Parameters:
partTypethe part type
NOTE: The full Unicode character set is not supported for this parameter.
partNumberthe part number
NOTE: The full Unicode character set is not supported for this parameter.
partRevisionthe part revision
NOTE: The full Unicode character set is not supported for this parameter.
partFileTypethe part file type
NOTE: The full Unicode character set is not supported for this parameter.
partFileNamethe part file name
NOTE: The full Unicode character set is not supported for this parameter.

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

Returns:
the new PDM::AlternateIdManager instance
Created in NX4.0.0.

License requirements : None

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

Returns:
the new PDM::DatabaseAttributeManager instance
Created in NX4.0.0.

License requirements : None

Sets the part number explicitly into builder.


This method is called before PDM::PartBuilder::CreatePartSpec

Created in NX5.0.0.

License requirements : None

Parameters:
partNumberthe part number
NOTE: The full Unicode character set is not supported for this parameter.

Sets the part type explicitly into builder.


This method is called before PDM::PartBuilder::CreatePartSpec

Created in NX5.0.0.

License requirements : None

Parameters:
partType
NOTE: The full Unicode character set is not supported for this parameter.

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


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 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.