FeatureProcessBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# FeatureProcessBuilder Class

class `NXOpen.CAM.``FeatureProcessBuilder`

  Bases: `NXOpen.Builder`

  The Create Feature Process Builder class creates operations and features groups

  To create a new instance of this class, use `NXOpen.CAM.CAMSetup.CreateFeatureProcessBuilder()`

  Default values.

  Property | Value
  --- | ---
  FeatureGrouping | UseExisting
  Type | RuleBased

  New in version NX7.5.0.

# Properties

Property | Description
--- | ---
FeatureGrouping | Returns or sets the way features are grouped in feature processes
Tag | Returns the Tag for this object.
Type | Returns or sets the type of feature process creation

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
CreateFeatureProcesses | Creates operations for a set of features based of the current setting of the builder
Destroy | Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit.
GetGeometryLocation | Returns the name of the geometry location of the generated feature processes
GetObject | Returns the object currently being edited by this builder.
GetRuleLibraries | Gets the active rule libraries
GetTemplate | Gets the template name and the feature process template
RecreateFeatureProcesses | Creates operations for a set of features based of the current setting of the builder
SetGeometryLocation | Returns the name of the geometry location of the generated feature processes
SetRuleLibraries | Sets the active rule libraries
SetTemplate | Sets the active template name and the feature process template
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

FeatureProcessBuilderFeatureGroupingType Enumeration | Determines how features are allocated to feature groups
FeatureProcessBuilderFeatureProcessType Enumeration | Type of creation

# Property Detail

## FeatureGrouping

`FeatureProcessBuilder.``FeatureGrouping`

  Returns or sets the way features are grouped in feature processes

  `-------------------------------------`

  Getter Method

  Signature `FeatureGrouping`

  Returns: |
  Return type: | `NXOpen.CAM.FeatureProcessBuilderFeatureGroupingType`

  New in version NX7.5.0.

  License requirements: ug_holemaking (“UG Holemaking”)

  `-------------------------------------`

  Setter Method

  Signature `FeatureGrouping`

  Parameters: | featureGrouping (`NXOpen.CAM.FeatureProcessBuilderFeatureGroupingType`) –

  New in version NX7.5.0.

  License requirements: ug_holemaking (“UG Holemaking”)

## Type

`FeatureProcessBuilder.``Type`

  Returns or sets the type of feature process creation

  `-------------------------------------`

  Getter Method

  Signature `Type`

  Returns: |
  Return type: | `NXOpen.CAM.FeatureProcessBuilderFeatureProcessType`

  New in version NX7.5.0.

  License requirements: ug_holemaking (“UG Holemaking”)

  `-------------------------------------`

  Setter Method

  Signature `Type`

  Parameters: | type (`NXOpen.CAM.FeatureProcessBuilderFeatureProcessType`) –

  New in version NX7.5.0.

  License requirements: ug_holemaking (“UG Holemaking”)

# Method Detail

## CreateFeatureProcesses

`FeatureProcessBuilder.``CreateFeatureProcesses`

  Creates operations for a set of features based of the current setting of the builder

  Signature `CreateFeatureProcesses(features)`

  Parameters: | features (list of `NXOpen.CAM.CAMFeature`) – The manufacturing features
  Returns: | a tuple
  Return type: | A tuple consisting of (operations, resultStatus). operations is a list of `NXOpen.CAM.Operation`. List with created operations, resultStatus is a `NXOpen.FeatureProcessBuilderStatus`. Result status of creating processes.

  New in version NX7.5.0.

  License requirements: ug_holemaking (“UG Holemaking”)

## GetGeometryLocation

`FeatureProcessBuilder.``GetGeometryLocation`

  Returns the name of the geometry location of the generated feature processes

  Signature `GetGeometryLocation()`

  Returns: | The parent group
  Return type: | str

  New in version NX7.5.0.

  License requirements: ug_holemaking (“UG Holemaking”)

## GetRuleLibraries

`FeatureProcessBuilder.``GetRuleLibraries`

  Gets the active rule libraries

  Signature `GetRuleLibraries()`

  Returns: |
  Return type: | list of str

  New in version NX7.5.0.

  License requirements: ug_holemaking (“UG Holemaking”)

## GetTemplate

`FeatureProcessBuilder.``GetTemplate`

  Gets the template name and the feature process template

  Signature `GetTemplate()`

  Returns: | a tuple
  Return type: | A tuple consisting of (activeTemplate, featureProcesTemplate) activeTemplate is a str. the template used featureProcesTemplate is a str. the feature process sub type used

  New in version NX7.5.0.

  License requirements: ug_holemaking (“UG Holemaking”)

## RecreateFeatureProcesses

`FeatureProcessBuilder.``RecreateFeatureProcesses`

  Creates operations for a set of features based of the current setting of the builder

  Signature `RecreateFeatureProcesses(groups)`

  Parameters: | groups (list of `NXOpen.CAM.FeatureGeometryGroup`) – The feature groups
  Returns: | a tuple
  Return type: | A tuple consisting of (operations, resultStatus). operations is a list of `NXOpen.CAM.Operation`. List with created operations, resultStatus is a `NXOpen.FeatureProcessBuilderStatus`. Result status of creating processes.

  New in version NX8.0.0.

  License requirements: ug_holemaking (“UG Holemaking”)

## SetGeometryLocation

`FeatureProcessBuilder.``SetGeometryLocation`

  Returns the name of the geometry location of the generated feature processes

  Signature `SetGeometryLocation(geometryLocation)`

  Parameters: | geometryLocation (str) – The parent group

  New in version NX7.5.0.

  License requirements: ug_holemaking (“UG Holemaking”)

## SetRuleLibraries

`FeatureProcessBuilder.``SetRuleLibraries`

  Sets the active rule libraries

  Signature `SetRuleLibraries(ruleLibraries)`

  Parameters: | ruleLibraries (list of str) –

  New in version NX7.5.0.

  License requirements: ug_holemaking (“UG Holemaking”)

## SetTemplate

`FeatureProcessBuilder.``SetTemplate`

  Sets the active template name and the feature process template

  Signature `SetTemplate(activeTemplate, featureProcesTemplate)`

  Parameters:

  - activeTemplate (str) – the template used
  - featureProcesTemplate (str) – the feature process sub type used

  New in version NX7.5.0.

  License requirements: ug_holemaking (“UG Holemaking”)

## Validate

`FeatureProcessBuilder.``Validate`

  Validate whether the inputs to the component are sufficient for commit to be called.

  If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

  Signature `Validate()`

  Returns: | Was self validation successful
  Return type: | bool

  New in version NX3.0.1.

  License requirements: None.