AlternateIdManager Class — NXOpen Python API Reference 12.0.0 documentation

# AlternateIdManager Class

class `NXOpen.PDM.``AlternateIdManager`

  Bases: `NXOpen.TransientObject`

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

  Use `PDM.PartBuilder.NewAlternateIdManager()` to get the instance of this class.

  New in version NX4.0.0.

# Methods

Method | Description
--- | ---
AssignAlternateId | This method generates alternate item and revision IDs and sets these generated values on this manager class.
AssignAlternateIds | Generates the alternate ID information by calling `AssignAlternateIds()` .
AssignAlternateRevId | This method generates an alternate rev ID and sets this generated value on this manager class.
AssignAlternateRevision | Generates the alternate Revision ID information.
CreateAlternateIdInformation | Adds the alternate ID information set by calling `SetAlternateIdInformation()` and the various assign and set methods.
Dispose | Free resources associated with the instance.
GetAllContexts | Gets a list of all the available contexts.
GetAllIdTypes | Gets a list of all the available ID types for a given context.
GetAlternateDescription | Gets the value of a alternate name as it is currently set on this manager class.
GetAlternateIdAsDefaultIndentifier | Gets (as it is currently set on this manager class) whether the alternate ID information should be the default indentifier.
GetAlternateItemId | Gets the value of a alternate ID as it is currently set on this manager class.
GetAlternateName | Gets the value of a alternate name as it is currently set on this manager class.
GetAlternateRevId | Gets the value of a alternate rev ID as it is currently set on this manager class.
GetContext | Gets the value of a context as it is currently set on this manager class.
GetIdType | Gets the value of a ID type as it is currently set on this manager class.
SetAlternateDescription | Sets the value of the alternate description.
SetAlternateIdAsDefaultIndentifier | Sets whether the alternate ID information should be the default indentifier.
SetAlternateIdInformation | Sets alternate ID information on this manager class.
SetAlternateItemId | Sets the value of the alternate item ID.
SetAlternateName | Sets the value of the alternate name.
SetAlternateRevId | Sets the value of the alternate rev ID.
SetContext | Sets the value of a context.
SetIdType | Sets the value of an ID type.

# Structs

AlternateIdManagerAlternateIdsData_Struct Struct | Contains alternate Ids data
AlternateIdManagerAssignAlternateRevData_Struct Struct | Contains alternate Revision Id data

# Method Detail

## AssignAlternateId

`AlternateIdManager.``AssignAlternateId`

  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.

  Signature `AssignAlternateId()`

  Returns: | a tuple
  Return type: | A tuple consisting of (alternateItemId, alternateRevId) alternateItemId is a str. the newly generated alternate item ID value that was set on this manager alternateRevId is a str. the newly generated alternate revision ID value that was set on this manager

  New in version NX4.0.0.

  License requirements: None.

## AssignAlternateIds

`AlternateIdManager.``AssignAlternateIds`

  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.

  Signature `AssignAlternateIds(context, idType)`

  Parameters:

  - context (str) – the context
  - idType (str) – the Id type

  Returns: | Contains alternate Ids data
  Return type: | `NXOpen.PDM.AlternateIdManagerAlternateIdsData_Struct`

  New in version NX5.0.0.

  License requirements: None.

## AssignAlternateRevId

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

  Signature `AssignAlternateRevId()`

  Returns: | the newly generated alternate rev ID

  value that was set on this manager :rtype: str

  New in version NX4.0.0.

  License requirements: None.

## AssignAlternateRevision

`AlternateIdManager.``AssignAlternateRevision`

  Generates the alternate Revision ID information.

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

  Signature `AssignAlternateRevision()`

  Returns: | Contains alternate Revision Id data
  Return type: | `NXOpen.PDM.AlternateIdManagerAssignAlternateRevData_Struct`

  New in version NX5.0.0.

  License requirements: None.

## CreateAlternateIdInformation

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

  Signature `CreateAlternateIdInformation()`

  New in version NX4.0.0.

  License requirements: None.

## Dispose

`AlternateIdManager.``Dispose`

  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.

  Signature `Dispose()`

  New in version NX4.0.0.

  License requirements: None.

## GetAllContexts

`AlternateIdManager.``GetAllContexts`

  Gets a list of all the available contexts.

  Signature `GetAllContexts()`

  Returns: | list of contexts
  Return type: | list of str

  New in version NX4.0.0.

  License requirements: None.

## GetAllIdTypes

`AlternateIdManager.``GetAllIdTypes`

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

  Signature `GetAllIdTypes(context)`

  Parameters: | context (str) – the context
  Returns: | list of ID types
  Return type: | list of str

  New in version NX4.0.0.

  License requirements: None.

## GetAlternateDescription

`AlternateIdManager.``GetAlternateDescription`

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

  Signature `GetAlternateDescription()`

  Returns: | the current value of the alternate

  description on this manager :rtype: str

  New in version NX4.0.0.

  License requirements: None.

## GetAlternateIdAsDefaultIndentifier

`AlternateIdManager.``GetAlternateIdAsDefaultIndentifier`

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

  Signature `GetAlternateIdAsDefaultIndentifier()`

  Returns: | the current value of option

  on this manager :rtype: bool

  New in version NX4.0.0.

  License requirements: None.

## GetAlternateItemId

`AlternateIdManager.``GetAlternateItemId`

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

  Signature `GetAlternateItemId()`

  Returns: | the current value of the alternate item ID on this manager
  Return type: | str

  New in version NX4.0.0.

  License requirements: None.

## GetAlternateName

`AlternateIdManager.``GetAlternateName`

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

  Signature `GetAlternateName()`

  Returns: | the current value of the alternate name on

  this manager :rtype: str

  New in version NX4.0.0.

  License requirements: None.

## GetAlternateRevId

`AlternateIdManager.``GetAlternateRevId`

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

  Signature `GetAlternateRevId()`

  Returns: | the current value of the alternate rev ID

  on this manager :rtype: str

  New in version NX4.0.0.

  License requirements: None.

## GetContext

`AlternateIdManager.``GetContext`

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

  Signature `GetContext()`

  Returns: | the current value of the context on this manager
  Return type: | str

  New in version NX4.0.0.

  License requirements: None.

## GetIdType

`AlternateIdManager.``GetIdType`

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

  Signature `GetIdType()`

  Returns: | the current value of the ID type on this manager
  Return type: | str

  New in version NX4.0.0.

  License requirements: None.

## SetAlternateDescription

`AlternateIdManager.``SetAlternateDescription`

  Sets the value of the alternate description.

  Signature `SetAlternateDescription(alternateDescription)`

  Parameters: | alternateDescription (str) – the new value the alternate description is to be set to

  New in version NX4.0.0.

  License requirements: None.

## SetAlternateIdAsDefaultIndentifier

`AlternateIdManager.``SetAlternateIdAsDefaultIndentifier`

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

  Signature `SetAlternateIdAsDefaultIndentifier(alternateIdAsDefaultIndentifier)`

  Parameters: | alternateIdAsDefaultIndentifier (bool) – the new value the option is to be set to

  New in version NX4.0.0.

  License requirements: None.

## SetAlternateIdInformation

`AlternateIdManager.``SetAlternateIdInformation`

  Sets alternate ID information on this manager class.

  None can be specified for parameters which are set via other set or assign methods on this builder.

  Signature `SetAlternateIdInformation(context, idType, alternateItemId, alternateRevId, alternateName, alternateDescription, alternateIdAsDefaultIndentifier)`

  Parameters:

  - context (str) – the new value the context is to be set to
  - idType (str) – the new value the ID type is to be set to
  - alternateItemId (str) – the new value the alternate item ID is to be set to
  - alternateRevId (str) – the new value the alternate rev ID is to be set to
  - alternateName (str) – the new value the alternate name is to be set to
  - alternateDescription (str) – the new value the alternate description is to be set to
  - alternateIdAsDefaultIndentifier (bool) – the new value the option is to be set to

  New in version NX4.0.0.

  License requirements: None.

## SetAlternateItemId

`AlternateIdManager.``SetAlternateItemId`

  Sets the value of the alternate item ID.

  Signature `SetAlternateItemId(alternateItemId)`

  Parameters: | alternateItemId (str) – the new value the alternate item ID is to be set to

  New in version NX4.0.0.

  License requirements: None.

## SetAlternateName

`AlternateIdManager.``SetAlternateName`

  Sets the value of the alternate name.

  Signature `SetAlternateName(alternateName)`

  Parameters: | alternateName (str) – the new value the alternate name is to be set to

  New in version NX4.0.0.

  License requirements: None.

## SetAlternateRevId

`AlternateIdManager.``SetAlternateRevId`

  Sets the value of the alternate rev ID.

  Signature `SetAlternateRevId(alternateRevId)`

  Parameters: | alternateRevId (str) – the new value the alternate rev ID is to be set to

  New in version NX4.0.0.

  License requirements: None.

## SetContext

`AlternateIdManager.``SetContext`

  Sets the value of a context.

  Signature `SetContext(context)`

  Parameters: | context (str) – the new value the context is to be set to

  New in version NX4.0.0.

  License requirements: None.

## SetIdType

`AlternateIdManager.``SetIdType`

  Sets the value of an ID type.

  Signature `SetIdType(idType)`

  Parameters: | idType (str) – the new value the ID type is to be set to

  New in version NX4.0.0.

  License requirements: None.