SubsetCollection Class — NXOpen Python API Reference 12.0.0 documentation

# SubsetCollection Class

class `NXOpen.Assemblies.``SubsetCollection`

  Bases: `object`

  Represents a collection of subset.

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

  New in version NX8.5.0.

# Methods

Method | Description
--- | ---
CreateAttributeSearchTermBuilder | Creates a `NXOpen.Assemblies.AttributeSearchTermBuilder`.
CreateBoxSearchTermBuilder | Creates a `NXOpen.Assemblies.BoxSearchTermBuilder`.
CreateMechanicalRoutingSubsetBuilder | Creates an `NXOpen.Assemblies.MechanicalRoutingSubsetBuilder`.
CreateMechanicalRoutingSubsetBuilderForSurroundingEdit | Creates an `NXOpen.Assemblies.MechanicalRoutingSubsetBuilder`.
CreatePlaneSearchTermBuilder | Creates a `NXOpen.Assemblies.PlaneSearchTermBuilder`.
CreatePositioningTaskBuilder | Creates a `NXOpen.Assemblies.PositioningTaskBuilder`
CreateProximitySearchTermBuilder | Creates a `NXOpen.Assemblies.ProximitySearchTermBuilder`.
CreateRunContentProximitySearchTermBuilder | Creates a `NXOpen.Assemblies.RunContentProximitySearchTermBuilder`.
CreateSubsetBuilder | Creates an `NXOpen.Assemblies.SubsetBuilder`

# Method Detail

## CreateAttributeSearchTermBuilder

`SubsetCollection.``CreateAttributeSearchTermBuilder`

  Creates a `NXOpen.Assemblies.AttributeSearchTermBuilder`.

  Signature `CreateAttributeSearchTermBuilder(attributeSearchTerm)`

  Parameters: | attributeSearchTerm (`NXOpen.Assemblies.AttributeSearchTerm`) – `NXOpen.Assemblies.AttributeSearchTerm` to be edited, if None then create a new one
  Returns: |
  Return type: | `NXOpen.Assemblies.AttributeSearchTermBuilder`

  New in version NX8.5.0.

  License requirements: nx_4gd_integration (“4th Generation Design”)

## CreateBoxSearchTermBuilder

`SubsetCollection.``CreateBoxSearchTermBuilder`

  Creates a `NXOpen.Assemblies.BoxSearchTermBuilder`.

  Signature `CreateBoxSearchTermBuilder(boxSearchTerm)`

  Parameters: | boxSearchTerm (`NXOpen.Assemblies.BoxSearchTerm`) – `NXOpen.Assemblies.BoxSearchTerm` to be edited, if None then create a new one
  Returns: |
  Return type: | `NXOpen.Assemblies.BoxSearchTermBuilder`

  New in version NX8.5.0.

  License requirements: nx_4gd_integration (“4th Generation Design”)

## CreateMechanicalRoutingSubsetBuilder

`SubsetCollection.``CreateMechanicalRoutingSubsetBuilder`

  Creates an `NXOpen.Assemblies.MechanicalRoutingSubsetBuilder`.

  The SubsetBuilder parameter is for editing of the existing routing subset.

  Signature `CreateMechanicalRoutingSubsetBuilder(subsetBuilderTag)`

  Parameters: | subsetBuilderTag (`NXOpen.Assemblies.SubsetBuilder`) –
  Returns: |
  Return type: | `NXOpen.Assemblies.MechanicalRoutingSubsetBuilder`

  New in version NX11.0.0.

  License requirements: nx_4gd_integration (“4th Generation Design”)

## CreateMechanicalRoutingSubsetBuilderForSurroundingEdit

`SubsetCollection.``CreateMechanicalRoutingSubsetBuilderForSurroundingEdit`

  Creates an `NXOpen.Assemblies.MechanicalRoutingSubsetBuilder`.

  The SubsetBuilder parameter is for editing of the existing surrounding subset’s recipe.

  Signature `CreateMechanicalRoutingSubsetBuilderForSurroundingEdit(subsetBuilderTag)`

  Parameters: | subsetBuilderTag (`NXOpen.Assemblies.SubsetBuilder`) –
  Returns: |
  Return type: | `NXOpen.Assemblies.MechanicalRoutingSubsetBuilder`

  New in version NX11.0.0.

  License requirements: nx_4gd_integration (“4th Generation Design”)

## CreatePlaneSearchTermBuilder

`SubsetCollection.``CreatePlaneSearchTermBuilder`

  Creates a `NXOpen.Assemblies.PlaneSearchTermBuilder`.

  Signature `CreatePlaneSearchTermBuilder(planeSearchTerm)`

  Parameters: | planeSearchTerm (`NXOpen.Assemblies.PlaneSearchTerm`) – `NXOpen.Assemblies.PlaneSearchTerm` to be edited, if None then create a new one
  Returns: |
  Return type: | `NXOpen.Assemblies.PlaneSearchTermBuilder`

  New in version NX8.5.0.

  License requirements: nx_4gd_integration (“4th Generation Design”)

## CreatePositioningTaskBuilder

`SubsetCollection.``CreatePositioningTaskBuilder`

  Creates a `NXOpen.Assemblies.PositioningTaskBuilder`

  Signature `CreatePositioningTaskBuilder(positioningTask)`

  Parameters: | positioningTask (`NXOpen.Assemblies.PositioningTask`) –
  Returns: |
  Return type: | `NXOpen.Assemblies.PositioningTaskBuilder`

  New in version NX10.0.0.

  License requirements: nx_4gd_integration (“4th Generation Design”)

## CreateProximitySearchTermBuilder

`SubsetCollection.``CreateProximitySearchTermBuilder`

  Creates a `NXOpen.Assemblies.ProximitySearchTermBuilder`.

  Signature `CreateProximitySearchTermBuilder(proximitySearchTerm)`

  Parameters: | proximitySearchTerm (`NXOpen.Assemblies.ProximitySearchTerm`) – `NXOpen.Assemblies.ProximitySearchTerm` to be edited, if None then create a new one
  Returns: |
  Return type: | `NXOpen.Assemblies.ProximitySearchTermBuilder`

  New in version NX8.5.0.

  License requirements: nx_4gd_integration (“4th Generation Design”)

## CreateRunContentProximitySearchTermBuilder

`SubsetCollection.``CreateRunContentProximitySearchTermBuilder`

  Creates a `NXOpen.Assemblies.RunContentProximitySearchTermBuilder`.

  Signature `CreateRunContentProximitySearchTermBuilder(runContentProximitySearchTerm)`

  Parameters: | runContentProximitySearchTerm (`NXOpen.Assemblies.RunContentProximitySearchTerm`) – `NXOpen.Assemblies.RunContentProximitySearchTerm` to be edited, if None then create a new one
  Returns: |
  Return type: | `NXOpen.Assemblies.RunContentProximitySearchTermBuilder`

  New in version NX11.0.0.

  License requirements: nx_4gd_integration (“4th Generation Design”)

## CreateSubsetBuilder

`SubsetCollection.``CreateSubsetBuilder`

  Creates an `NXOpen.Assemblies.SubsetBuilder`

  Signature `CreateSubsetBuilder(subset)`

  Parameters: | subset (`NXOpen.Assemblies.Subset`) – `NXOpen.Assemblies.Subset` to be edited, if None then create a new one
  Returns: |
  Return type: | `NXOpen.Assemblies.SubsetBuilder`

  New in version NX8.5.0.

  License requirements: nx_4gd_integration (“4th Generation Design”)