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

struct	_AssignAlternateRevData
	Contains alternate Revision Id data

struct	AlternateIdsData
	Contains alternate Ids data More...

struct	AssignAlternateRevData
	Contains alternate Revision Id data More...

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

unsafe NXOpen.PDM.AlternateIdManager.AlternateIdsData	AssignAlternateIds (string context, string idType)
	Generates the alternate ID information by calling AssignAlternateIds . More...

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

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

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

unsafe string[]	GetAllContexts ()
	Gets a list of all the available contexts. More...

unsafe string[]	GetAllIdTypes (string context)
	Gets a list of all the available ID types for a given context. More...

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

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

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

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

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

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

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

unsafe void	SetAlternateDescription (string alternateDescription)
	Sets the value of the alternate description. More...

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

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

unsafe void	SetAlternateItemId (string alternateItemId)
	Sets the value of the alternate item ID. More...

unsafe void	SetAlternateName (string alternateName)
	Sets the value of the alternate name. More...

unsafe void	SetAlternateRevId (string alternateRevId)
	Sets the value of the alternate rev ID. More...

unsafe void	SetContext (string context)
	Sets the value of a context. More...

unsafe void	SetIdType (string idType)
	Sets the value of an ID type. 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 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

Member Function Documentation

unsafe void NXOpen.PDM.AlternateIdManager.AssignAlternateId	(	out string	alternateItemId,
		out string	alternateRevId
	)

inline

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

unsafe NXOpen.PDM.AlternateIdManager.AlternateIdsData NXOpen.PDM.AlternateIdManager.AssignAlternateIds	(	string	context,
		string	idType
	)

inline

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.

Created in NX5.0.0

License requirements: None.

Parameters

context	the context
idType	the Id type

Returns: Contains alternate Ids data

unsafe string NXOpen.PDM.AlternateIdManager.AssignAlternateRevId ( )

inline

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.

Created in NX4.0.0

License requirements: None.

Returns: the newly generated alternate rev ID value that was set on this manager

unsafe NXOpen.PDM.AlternateIdManager.AssignAlternateRevData NXOpen.PDM.AlternateIdManager.AssignAlternateRevision ( )

inline

Generates the alternate Revision ID information.

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

Created in NX5.0.0

License requirements: None.

Returns: Contains alternate Revision Id data

unsafe void NXOpen.PDM.AlternateIdManager.CreateAlternateIdInformation ( )

inline

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.

override void NXOpen.PDM.AlternateIdManager.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.

unsafe string [] NXOpen.PDM.AlternateIdManager.GetAllContexts ( )

inline

Gets a list of all the available contexts.

Created in NX4.0.0

License requirements: None.

Returns: list of contexts

unsafe string [] NXOpen.PDM.AlternateIdManager.GetAllIdTypes ( string context )

inline

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

Created in NX4.0.0

License requirements: None.

Parameters

context the context

Returns: list of ID types

unsafe string NXOpen.PDM.AlternateIdManager.GetAlternateDescription ( )

inline

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

Created in NX4.0.0

License requirements: None.

Returns: the current value of the alternate description on this manager

unsafe bool NXOpen.PDM.AlternateIdManager.GetAlternateIdAsDefaultIndentifier ( )

inline

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

Created in NX4.0.0

License requirements: None.

Returns: the current value of option on this manager

unsafe string NXOpen.PDM.AlternateIdManager.GetAlternateItemId ( )

inline

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

Created in NX4.0.0

License requirements: None.

Returns: the current value of the alternate item ID on this manager

unsafe string NXOpen.PDM.AlternateIdManager.GetAlternateName ( )

inline

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

Created in NX4.0.0

License requirements: None.

Returns: the current value of the alternate name on this manager

unsafe string NXOpen.PDM.AlternateIdManager.GetAlternateRevId ( )

inline

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

Created in NX4.0.0

License requirements: None.

Returns: the current value of the alternate rev ID on this manager

unsafe string NXOpen.PDM.AlternateIdManager.GetContext ( )

inline

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

Created in NX4.0.0

License requirements: None.

Returns: the current value of the context on this manager

unsafe string NXOpen.PDM.AlternateIdManager.GetIdType ( )

inline

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

Created in NX4.0.0

License requirements: None.

Returns: the current value of the ID type on this manager

unsafe void NXOpen.PDM.AlternateIdManager.SetAlternateDescription ( string alternateDescription )

inline

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

unsafe void NXOpen.PDM.AlternateIdManager.SetAlternateIdAsDefaultIndentifier ( bool alternateIdAsDefaultIndentifier )

inline

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

unsafe void NXOpen.PDM.AlternateIdManager.SetAlternateIdInformation	(	string	context,
		string	idType,
		string	alternateItemId,
		string	alternateRevId,
		string	alternateName,
		string	alternateDescription,
		bool	alternateIdAsDefaultIndentifier
	)

inline

Sets alternate ID information on this manager class.

a null reference (Nothing in Visual Basic) 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

unsafe void NXOpen.PDM.AlternateIdManager.SetAlternateItemId ( string alternateItemId )

inline

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

unsafe void NXOpen.PDM.AlternateIdManager.SetAlternateName ( string alternateName )

inline

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

unsafe void NXOpen.PDM.AlternateIdManager.SetAlternateRevId ( string alternateRevId )

inline

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

unsafe void NXOpen.PDM.AlternateIdManager.SetContext ( string context )

inline

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

unsafe void NXOpen.PDM.AlternateIdManager.SetIdType ( string idType )

inline

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

Classes

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation