This class is responsible for setting and getting NX Manager database attribute. More...

Inheritance diagram for NXOpen::PDM::AlternateIdManager:

Classes
struct	AlternateIdsData
	Contains alternate Ids data. More...

struct	AssignAlternateRevData
	Contains alternate Revision Id data. More...

Public Member Functions
void	AssignAlternateId (NXString alternateItemId, NXString alternateRevId)
	This method generates alternate item and revision IDs and sets these generated values on this manager class. More...

NXOpen::PDM::AlternateIdManager::AlternateIdsData	AssignAlternateIds (const NXString &context, const NXString &idType)
	Generates the alternate ID information by calling AssignAlternateIds . More...

NXOpen::PDM::AlternateIdManager::AlternateIdsData	AssignAlternateIds (const char context, const char idType)
	Generates the alternate ID information by calling AssignAlternateIds . More...

NXString	AssignAlternateRevId ()
	This method generates an alternate rev ID and sets this generated value on this manager class. More...

NXOpen::PDM::AlternateIdManager::AssignAlternateRevData	AssignAlternateRevision ()
	Generates the alternate Revision ID information. More...

void	CreateAlternateIdInformation ()
	Adds the alternate ID information set by calling SetAlternateIdInformation and the various "assign" and "set" methods. More...

std::vector< NXString >	GetAllContexts ()
	Gets a list of all the available contexts. More...

std::vector< NXString >	GetAllIdTypes (const NXString &context)
	Gets a list of all the available ID types for a given context. More...

std::vector< NXString >	GetAllIdTypes (const char *context)
	Gets a list of all the available ID types for a given context. More...

NXString	GetAlternateDescription ()
	Gets the value of a alternate name as it is currently set on this manager class. More...

bool	GetAlternateIdAsDefaultIndentifier ()
	Gets (as it is currently set on this manager class) whether the alternate ID information should be the default indentifier. More...

NXString	GetAlternateItemId ()
	Gets the value of a alternate ID as it is currently set on this manager class. More...

NXString	GetAlternateName ()
	Gets the value of a alternate name as it is currently set on this manager class. More...

NXString	GetAlternateRevId ()
	Gets the value of a alternate rev ID as it is currently set on this manager class. More...

NXString	GetContext ()
	Gets the value of a context as it is currently set on this manager class. More...

NXString	GetIdType ()
	Gets the value of a ID type as it is currently set on this manager class. More...

void	SetAlternateDescription (const NXString &alternateDescription)
	Sets the value of the alternate description. More...

void	SetAlternateDescription (const char *alternateDescription)
	Sets the value of the alternate description. More...

void	SetAlternateIdAsDefaultIndentifier (bool alternateIdAsDefaultIndentifier)
	Sets whether the alternate ID information should be the default indentifier. More...

void	SetAlternateIdInformation (const NXString &context, const NXString &idType, const NXString &alternateItemId, const NXString &alternateRevId, const NXString &alternateName, const NXString &alternateDescription, bool alternateIdAsDefaultIndentifier)
	Sets alternate ID information on this manager class. More...

void	SetAlternateIdInformation (const char context, const char idType, const char alternateItemId, const char alternateRevId, const char alternateName, const char alternateDescription, bool alternateIdAsDefaultIndentifier)
	Sets alternate ID information on this manager class. More...

void	SetAlternateItemId (const NXString &alternateItemId)
	Sets the value of the alternate item ID. More...

void	SetAlternateItemId (const char *alternateItemId)
	Sets the value of the alternate item ID. More...

void	SetAlternateName (const NXString &alternateName)
	Sets the value of the alternate name. More...

void	SetAlternateName (const char *alternateName)
	Sets the value of the alternate name. More...

void	SetAlternateRevId (const NXString &alternateRevId)
	Sets the value of the alternate rev ID. More...

void	SetAlternateRevId (const char *alternateRevId)
	Sets the value of the alternate rev ID. More...

void	SetContext (const NXString &context)
	Sets the value of a context. More...

void	SetContext (const char *context)
	Sets the value of a context. More...

void	SetIdType (const NXString &idType)
	Sets the value of an ID type. More...

void	SetIdType (const char *idType)
	Sets the value of an ID type. More...

virtual	~AlternateIdManager ()
	Free resources associated with the instance. More...

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

Detailed Description

This class is responsible for setting and getting NX Manager database attribute.

Use PDM::PartBuilder::NewAlternateIdManager to get the instance of this class.

Created in NX4.0.0.

Constructor & Destructor Documentation

virtual NXOpen::PDM::AlternateIdManager::~AlternateIdManager ( )

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

void NXOpen::PDM::AlternateIdManager::AssignAlternateId	(	NXString *	alternateItemId,
		NXString *	alternateRevId
	)

This method generates alternate item and revision IDs and sets these generated values on this manager class.

Note that the ID context and type must be set on the builder in order for this assign operation to be successful.
Created in NX4.0.0.

License requirements : None

Parameters

alternateItemId	the newly generated alternate item ID value that was set on this manager
alternateRevId	the newly generated alternate revision ID value that was set on this manager

NXOpen::PDM::AlternateIdManager::AlternateIdsData NXOpen::PDM::AlternateIdManager::AssignAlternateIds	(	const NXString &	context,
		const NXString &	idType
	)

Generates the alternate ID information by calling AssignAlternateIds .

Returns pointer to PDM.Altids.AlternateIdsData object. Sets Alternate Name,Alternate Id,Alternate Revision ,Alternate Description, flag for alternate Id modifiable and flag for revision modifiable into Alternate Manager object.

Returns: Contains alternate Ids data
Created in NX5.0.0.

License requirements : None

Parameters

context	the context
idType	the Id type

NXOpen::PDM::AlternateIdManager::AlternateIdsData NXOpen::PDM::AlternateIdManager::AssignAlternateIds	(	const char *	context,
		const char *	idType
	)

Generates the alternate ID information by calling AssignAlternateIds .

Returns pointer to PDM.Altids.AlternateIdsData object. Sets Alternate Name,Alternate Id,Alternate Revision ,Alternate Description, flag for alternate Id modifiable and flag for revision modifiable into Alternate Manager object.

Returns: Contains alternate Ids data
Created in NX5.0.0.

License requirements : None

Parameters

context	the context
idType	the Id type

NXString NXOpen::PDM::AlternateIdManager::AssignAlternateRevId ( )

This method generates an alternate rev ID and sets this generated value on this manager class.

Note that the ID context and type must be set on the builder in order for this assign operation to be successful.

Returns: the newly generated alternate rev ID value that was set on this manager
Created in NX4.0.0.

License requirements : None

NXOpen::PDM::AlternateIdManager::AssignAlternateRevData NXOpen::PDM::AlternateIdManager::AssignAlternateRevision ( )

Generates the alternate Revision ID information.

Sets Alternate Revision and flag for revision modifiable into Alternate Manager object.

Returns: Contains alternate Revision Id data
Created in NX5.0.0.

License requirements : None

void NXOpen::PDM::AlternateIdManager::CreateAlternateIdInformation ( )

Adds the alternate ID information set by calling SetAlternateIdInformation and the various "assign" and "set" methods.

The context, ID type, alternate ID, alternate revision ID, and the alternate name must all be set before calling this method.
Created in NX4.0.0.

License requirements : None

std::vector<NXString> NXOpen::PDM::AlternateIdManager::GetAllContexts ( )

Gets a list of all the available contexts.

Returns: list of contexts
Created in NX4.0.0.

License requirements : None

std::vector<NXString> NXOpen::PDM::AlternateIdManager::GetAllIdTypes ( const NXString & context )

Gets a list of all the available ID types for a given context.

Returns: list of ID types
Created in NX4.0.0.

License requirements : None

Parameters

context the context

std::vector<NXString> NXOpen::PDM::AlternateIdManager::GetAllIdTypes ( const char * context )

Gets a list of all the available ID types for a given context.

Returns: list of ID types
Created in NX4.0.0.

License requirements : None

Parameters

context the context

NXString NXOpen::PDM::AlternateIdManager::GetAlternateDescription ( )

Gets the value of a alternate name as it is currently set on this manager class.

Returns: the current value of the alternate description on this manager
Created in NX4.0.0.

License requirements : None

bool NXOpen::PDM::AlternateIdManager::GetAlternateIdAsDefaultIndentifier ( )

Gets (as it is currently set on this manager class) whether the alternate ID information should be the default indentifier.

Returns: the current value of option on this manager
Created in NX4.0.0.

License requirements : None

NXString NXOpen::PDM::AlternateIdManager::GetAlternateItemId ( )

Gets the value of a alternate ID as it is currently set on this manager class.

Returns: the current value of the alternate item ID on this manager
Created in NX4.0.0.

License requirements : None

NXString NXOpen::PDM::AlternateIdManager::GetAlternateName ( )

Gets the value of a alternate name as it is currently set on this manager class.

Returns: the current value of the alternate name on this manager
Created in NX4.0.0.

License requirements : None

NXString NXOpen::PDM::AlternateIdManager::GetAlternateRevId ( )

Gets the value of a alternate rev ID as it is currently set on this manager class.

Returns: the current value of the alternate rev ID on this manager
Created in NX4.0.0.

License requirements : None

NXString NXOpen::PDM::AlternateIdManager::GetContext ( )

Gets the value of a context as it is currently set on this manager class.

Returns: the current value of the context on this manager
Created in NX4.0.0.

License requirements : None

NXString NXOpen::PDM::AlternateIdManager::GetIdType ( )

Gets the value of a ID type as it is currently set on this manager class.

Returns: the current value of the ID type on this manager
Created in NX4.0.0.

License requirements : None

void NXOpen::PDM::AlternateIdManager::SetAlternateDescription ( const NXString & alternateDescription )

Sets the value of the alternate description.

Created in NX4.0.0.

License requirements : None

Parameters

alternateDescription the new value the alternate description is to be set to

void NXOpen::PDM::AlternateIdManager::SetAlternateDescription ( const char * alternateDescription )

Sets the value of the alternate description.

Created in NX4.0.0.

License requirements : None

Parameters

alternateDescription the new value the alternate description is to be set to

void NXOpen::PDM::AlternateIdManager::SetAlternateIdAsDefaultIndentifier ( bool alternateIdAsDefaultIndentifier )

Sets whether the alternate ID information should be the default indentifier.

Created in NX4.0.0.

License requirements : None

Parameters

alternateIdAsDefaultIndentifier the new value the option is to be set to

void NXOpen::PDM::AlternateIdManager::SetAlternateIdInformation	(	const NXString &	context,
		const NXString &	idType,
		const NXString &	alternateItemId,
		const NXString &	alternateRevId,
		const NXString &	alternateName,
		const NXString &	alternateDescription,
		bool	alternateIdAsDefaultIndentifier
	)

Sets alternate ID information on this manager class.

NULL can be specified for parameters which are set via other set or assign methods on this builder.
Created in NX4.0.0.

License requirements : None

Parameters

context	the new value the context is to be set to
idType	the new value the ID type is to be set to
alternateItemId	the new value the alternate item ID is to be set to
alternateRevId	the new value the alternate rev ID is to be set to
alternateName	the new value the alternate name is to be set to
alternateDescription	the new value the alternate description is to be set to
alternateIdAsDefaultIndentifier	the new value the option is to be set to

void NXOpen::PDM::AlternateIdManager::SetAlternateIdInformation	(	const char *	context,
		const char *	idType,
		const char *	alternateItemId,
		const char *	alternateRevId,
		const char *	alternateName,
		const char *	alternateDescription,
		bool	alternateIdAsDefaultIndentifier
	)

Sets alternate ID information on this manager class.

NULL can be specified for parameters which are set via other set or assign methods on this builder.
Created in NX4.0.0.

License requirements : None

Parameters

context	the new value the context is to be set to
idType	the new value the ID type is to be set to
alternateItemId	the new value the alternate item ID is to be set to
alternateRevId	the new value the alternate rev ID is to be set to
alternateName	the new value the alternate name is to be set to
alternateDescription	the new value the alternate description is to be set to
alternateIdAsDefaultIndentifier	the new value the option is to be set to

void NXOpen::PDM::AlternateIdManager::SetAlternateItemId ( const NXString & alternateItemId )

Sets the value of the alternate item ID.

Created in NX4.0.0.

License requirements : None

Parameters

alternateItemId the new value the alternate item ID is to be set to

void NXOpen::PDM::AlternateIdManager::SetAlternateItemId ( const char * alternateItemId )

Sets the value of the alternate item ID.

Created in NX4.0.0.

License requirements : None

Parameters

alternateItemId the new value the alternate item ID is to be set to

void NXOpen::PDM::AlternateIdManager::SetAlternateName ( const NXString & alternateName )

Sets the value of the alternate name.

Created in NX4.0.0.

License requirements : None

Parameters

alternateName the new value the alternate name is to be set to

void NXOpen::PDM::AlternateIdManager::SetAlternateName ( const char * alternateName )

Sets the value of the alternate name.

Created in NX4.0.0.

License requirements : None

Parameters

alternateName the new value the alternate name is to be set to

void NXOpen::PDM::AlternateIdManager::SetAlternateRevId ( const NXString & alternateRevId )

Sets the value of the alternate rev ID.

Created in NX4.0.0.

License requirements : None

Parameters

alternateRevId the new value the alternate rev ID is to be set to

void NXOpen::PDM::AlternateIdManager::SetAlternateRevId ( const char * alternateRevId )

Sets the value of the alternate rev ID.

Created in NX4.0.0.

License requirements : None

Parameters

alternateRevId the new value the alternate rev ID is to be set to

void NXOpen::PDM::AlternateIdManager::SetContext ( const NXString & context )

Sets the value of a context.

Created in NX4.0.0.

License requirements : None

Parameters

context the new value the context is to be set to

void NXOpen::PDM::AlternateIdManager::SetContext ( const char * context )

Sets the value of a context.

Created in NX4.0.0.

License requirements : None

Parameters

context the new value the context is to be set to

void NXOpen::PDM::AlternateIdManager::SetIdType ( const NXString & idType )

Sets the value of an ID type.

Created in NX4.0.0.

License requirements : None

Parameters

idType the new value the ID type is to be set to

void NXOpen::PDM::AlternateIdManager::SetIdType ( const char * idType )

Sets the value of an ID type.

Created in NX4.0.0.

License requirements : None

Parameters

idType the new value the ID type is to be set to

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

PDM_AlternateIdManager.hxx

Classes

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation