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

Inheritance diagram for NXOpen::PDM::PartBuilder:

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.

NXString	AssignPartFileName (const char *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.

NXOpen::PDM::PartBuilder::PartFileNameData	AssignPartFileName (const char partNumber, const char partRevision, const char partFileNameType, const char 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.

NXString	AssignPartNumber (const char *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.

NXOpen::PDM::PartBuilder::PartNumberData	AssignPartNumber (const char oldPartNumber, const char 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::PartCreationObject *	CreatePartCreationObject ()
	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.

void	CreatePartSpec (const char partType, const char partNumber, const char partRevision, const char partFileType, const char *partFileName)
	Create the specification for the new part that will be created.

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

NXOpen::PDM::DatabaseAttributeManager *	NewDatabaseAttributeManager ()
	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	SetAssignPartNumber (const char *partNumber)
	Sets the part number explicitly into builder.

void	SetAssignPartType (const NXString &partType)
	Sets the part type explicitly into builder.

void	SetAssignPartType (const char *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.

Public Member Functions inherited from NXOpen::TransientObject
void *	GetHandle ()
	Handle of the internal object represented by this object.

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

enum NXOpen::PDM::PartBuilder::Operation

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

virtual NXOpen::PDM::PartBuilder::~PartBuilder ( )

virtual

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

NXString NXOpen::PDM::PartBuilder::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.

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

    <br> 
   If this method is called before @link PDM::PartBuilder::CreatePartSpec PDM::PartBuilder::CreatePartSpec@endlink 
   (as will typically be the case) then the <b>part_file_type</b> and
   <b>part_file_name</b> parameters of
   @link PDM::PartBuilder::CreatePartSpec PDM::PartBuilder::CreatePartSpec@endlink 
   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 <b>part_file_type</b> and <b>part_file_name</b>
   parameters to the builder.
    <br> 

    @return  the assigned part file name

Created in NX4.0.0.

License requirements : None

Parameters

partFileType the 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.

NXString NXOpen::PDM::PartBuilder::AssignPartFileName ( const char * partFileType )

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

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

    <br> 
   If this method is called before @link PDM::PartBuilder::CreatePartSpec PDM::PartBuilder::CreatePartSpec@endlink 
   (as will typically be the case) then the <b>part_file_type</b> and
   <b>part_file_name</b> parameters of
   @link PDM::PartBuilder::CreatePartSpec PDM::PartBuilder::CreatePartSpec@endlink 
   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 <b>part_file_type</b> and <b>part_file_name</b>
   parameters to the builder.
    <br> 

    @return  the assigned part file name

Created in NX4.0.0.

License requirements : None

Parameters

partFileType the 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.

    <br> 
   If this method is called before @link PDM::PartBuilder::CreatePartSpec PDM::PartBuilder::CreatePartSpec@endlink 
   then the <b>part_file_name</b> parameter of @link PDM::PartBuilder::CreatePartSpec PDM::PartBuilder::CreatePartSpec@endlink 
   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 <b>part_file_type</b> and <b>part_file_name</b>
   parameters to the builder.
    <br> 

    @return

Created in NX5.0.0.

License requirements : None

Parameters

partNumber	Part Number NOTE: The full Unicode character set is not supported for this parameter.
partRevision	part revision NOTE: The full Unicode character set is not supported for this parameter.
partFileNameType	Part 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.
oldPartFileName	Old part file name NOTE: The full Unicode character set is not supported for this parameter.

NXOpen::PDM::PartBuilder::PartFileNameData NXOpen::PDM::PartBuilder::AssignPartFileName	(	const char *	partNumber,
		const char *	partRevision,
		const char *	partFileNameType,
		const char *	oldPartFileName
	)

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

    <br> 
   If this method is called before @link PDM::PartBuilder::CreatePartSpec PDM::PartBuilder::CreatePartSpec@endlink 
   then the <b>part_file_name</b> parameter of @link PDM::PartBuilder::CreatePartSpec PDM::PartBuilder::CreatePartSpec@endlink 
   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 <b>part_file_type</b> and <b>part_file_name</b>
   parameters to the builder.
    <br> 

    @return

Created in NX5.0.0.

License requirements : None

Parameters

partNumber	Part Number NOTE: The full Unicode character set is not supported for this parameter.
partRevision	part revision NOTE: The full Unicode character set is not supported for this parameter.
partFileNameType	Part 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.
oldPartFileName	Old part file name NOTE: The full Unicode character set is not supported for this parameter.

NXString NXOpen::PDM::PartBuilder::AssignPartNumber ( const NXString & partType )

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

    <br> 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 @link PDM::PartBuilder::CreatePartSpec PDM::PartBuilder::CreatePartSpec@endlink .
    <br> 

    <br> 
   If this method is called before @link PDM::PartBuilder::CreatePartSpec PDM::PartBuilder::CreatePartSpec@endlink 
   (as will typically be the case) then the <b>part_type</b> and
   <b>part_number</b> parameters of
   @link PDM::PartBuilder::CreatePartSpec PDM::PartBuilder::CreatePartSpec@endlink 
   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 <b>part_type</b> and <b>part_number</b>
   parameters to the builder.
    <br> 
    @return  the assigned part number

Created in NX4.0.0.

License requirements : None

Parameters

partType the part type
NOTE: The full Unicode character set is not supported for this parameter.

NXString NXOpen::PDM::PartBuilder::AssignPartNumber ( const char * partType )

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

    <br> 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 @link PDM::PartBuilder::CreatePartSpec PDM::PartBuilder::CreatePartSpec@endlink .
    <br> 

    <br> 
   If this method is called before @link PDM::PartBuilder::CreatePartSpec PDM::PartBuilder::CreatePartSpec@endlink 
   (as will typically be the case) then the <b>part_type</b> and
   <b>part_number</b> parameters of
   @link PDM::PartBuilder::CreatePartSpec PDM::PartBuilder::CreatePartSpec@endlink 
   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 <b>part_type</b> and <b>part_number</b>
   parameters to the builder.
    <br> 
    @return  the assigned part number

Created in NX4.0.0.

License requirements : None

Parameters

partType the part type
NOTE: The full Unicode character set is not supported for this parameter.

NXOpen::PDM::PartBuilder::PartNumberData NXOpen::PDM::PartBuilder::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.

    <br> 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 @link PDM::PartBuilder::CreatePartSpec PDM::PartBuilder::CreatePartSpec@endlink .
    <br> 

    <br> 
   If this overloaded method is called before @link PDM::PartBuilder::CreatePartSpec PDM::PartBuilder::CreatePartSpec@endlink 
   then the <b>part_number</b> parameter of
   @link PDM::PartBuilder::CreatePartSpec PDM::PartBuilder::CreatePartSpec@endlink 
   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 <b>part_number</b>
   parameter to the builder.
    <br> 
    @return  Contains part number information.

Created in NX5.0.0.

License requirements : None

Parameters

oldPartNumber	Old part number NOTE: The full Unicode character set is not supported for this parameter.
partType	Part type NOTE: The full Unicode character set is not supported for this parameter.

NXOpen::PDM::PartBuilder::PartNumberData NXOpen::PDM::PartBuilder::AssignPartNumber	(	const char *	oldPartNumber,
		const char *	partType
	)

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

    <br> 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 @link PDM::PartBuilder::CreatePartSpec PDM::PartBuilder::CreatePartSpec@endlink .
    <br> 

    <br> 
   If this overloaded method is called before @link PDM::PartBuilder::CreatePartSpec PDM::PartBuilder::CreatePartSpec@endlink 
   then the <b>part_number</b> parameter of
   @link PDM::PartBuilder::CreatePartSpec PDM::PartBuilder::CreatePartSpec@endlink 
   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 <b>part_number</b>
   parameter to the builder.
    <br> 
    @return  Contains part number information.

Created in NX5.0.0.

License requirements : None

Parameters

oldPartNumber	Old part number NOTE: The full Unicode character set is not supported for this parameter.
partType	Part type NOTE: The full Unicode character set is not supported for this parameter.

NXString NXOpen::PDM::PartBuilder::AssignPartRevision ( )

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

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

    <br> 
   If this method is called before @link PDM::PartBuilder::CreatePartSpec PDM::PartBuilder::CreatePartSpec@endlink 
   (as will typically be the case) then the <b>part_revision</b> parameter of
   @link PDM::PartBuilder::CreatePartSpec PDM::PartBuilder::CreatePartSpec@endlink 
   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 <b>part_revision</b>
   parameters to the builder.
    <br> 
    @return  the assigned part revision

Created in NX4.0.0.

License requirements : None

NXOpen::PDM::PartBuilder::PartRevisionData NXOpen::PDM::PartBuilder::AssignPartRevision ( int overload )

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

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

    <br> If this method is called before @link PDM::PartBuilder::CreatePartSpec PDM::PartBuilder::CreatePartSpec@endlink 
   then the <b>part_revision</b> parameter of
   @link PDM::PartBuilder::CreatePartSpec PDM::PartBuilder::CreatePartSpec@endlink 
   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 <b>part_revision</b>
   parameters to the builder.
    <br> 
    @return  Contains part revision information

Created in NX5.0.0.

License requirements : None

Parameters

overload Dummy parameter to call this overloaded method

NXOpen::PDM::PartCreationObject* NXOpen::PDM::PartBuilder::CreatePartCreationObject ( )

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

partType	the part type NOTE: The full Unicode character set is not supported for this parameter.
partNumber	the part number NOTE: The full Unicode character set is not supported for this parameter.
partRevision	the part revision NOTE: The full Unicode character set is not supported for this parameter.
partFileType	the part file type NOTE: The full Unicode character set is not supported for this parameter.
partFileName	the part file name NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::PDM::PartBuilder::CreatePartSpec	(	const char *	partType,
		const char *	partNumber,
		const char *	partRevision,
		const char *	partFileType,
		const char *	partFileName
	)

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

Created in NX4.0.0.

License requirements : None

Parameters

partType	the part type NOTE: The full Unicode character set is not supported for this parameter.
partNumber	the part number NOTE: The full Unicode character set is not supported for this parameter.
partRevision	the part revision NOTE: The full Unicode character set is not supported for this parameter.
partFileType	the part file type NOTE: The full Unicode character set is not supported for this parameter.
partFileName	the part file name NOTE: The full Unicode character set is not supported for this parameter.

NXOpen::PDM::AlternateIdManager* NXOpen::PDM::PartBuilder::NewAlternateIdManager ( )

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

NXOpen::PDM::DatabaseAttributeManager* NXOpen::PDM::PartBuilder::NewDatabaseAttributeManager ( )

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

void NXOpen::PDM::PartBuilder::SetAssignPartNumber ( const NXString & partNumber )

Sets the part number explicitly into builder.

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

Created in NX5.0.0.

License requirements : None

Parameters

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

void NXOpen::PDM::PartBuilder::SetAssignPartNumber ( const char * partNumber )

Sets the part number explicitly into builder.

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

Created in NX5.0.0.

License requirements : None

Parameters

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

void NXOpen::PDM::PartBuilder::SetAssignPartType ( const NXString & partType )

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.

void NXOpen::PDM::PartBuilder::SetAssignPartType ( const char * partType )

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.

void NXOpen::PDM::PartBuilder::SetContextOperation ( NXOpen::PDM::PartBuilder::Operation operation )

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

Created in NX5.0.0.

License requirements : None

Parameters

operation Token identifying place from where UG/Manager part selection dialog invoked

The documentation for this class was generated from the following file:

PDM_PartBuilder.hxx

Classes

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation