ComponentPatternCollection Class — NXOpen Python API Reference 12.0.0 documentation

# ComponentPatternCollection Class

class `NXOpen.Assemblies.``ComponentPatternCollection`

  Bases: `object`

  Represents the collection object for all component patterns.

  An instance of this class can be obtained from the `NXOpen.Assemblies.ComponentAssembly`.

  To obtain an instance of this class, refer to `NXOpen.Assemblies.ComponentAssembly`

  New in version NX9.0.0.

# Methods

Method | Description
--- | ---
FindObject | Finds the `NXOpen.Assemblies.ComponentPattern` with the given identifier as recorded in a journal.
GetAllComponentPatterns | Returns all the component patterns in an assembly.

# Method Detail

## FindObject

`ComponentPatternCollection.``FindObject`

  Finds the `NXOpen.Assemblies.ComponentPattern` with the given identifier as recorded in a journal.

  An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals. An exception will be thrown if no object can be found with the given journal identifier.

  Signature `FindObject(journalIdentifier)`

  Parameters: | journalIdentifier (str) – Name of the component pattern to be found
  Returns: | Component pattern with this identifier, or None if no such pattern exists
  Return type: | `NXOpen.Assemblies.ComponentPattern`

  New in version NX9.0.0.

  License requirements: None.

## GetAllComponentPatterns

`ComponentPatternCollection.``GetAllComponentPatterns`

  Returns all the component patterns in an assembly.

  Signature `GetAllComponentPatterns()`

  Returns: |
  Return type: | list of `NXOpen.Assemblies.ComponentPattern`

  New in version NX9.0.0.

  License requirements: None.