GroupFeatures Class — NXOpen Python API Reference 12.0.0 documentation

# GroupFeatures Class

class `NXOpen.CAM.``GroupFeatures`

  Bases: `NXOpen.Builder`

  Represents the group features command

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

  Default values.

  Property | Value
  --- | ---
  FeaturesToGroupType | All
  GroupByAttributes | Predefined
  GroupByMachiningAccessDirection | false

  New in version NX9.0.0.

# Properties

Property | Description
--- | ---
FeaturesToGroupType | Returns or sets the features to group enumeration
GeometryLocation | Returns or sets the geometry location
GroupByAttributes | Returns or sets the group by attributes options - None, All, Predefined
GroupByIdenticalAttributes | Returns or sets the group by identical attributes flag
GroupByMachiningAccessDirection | Returns or sets the group by machining access direction flag
Tag | Returns the Tag for this object.
TopFaceCollector | Returns the top face collector

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
CreateFeatureGroups | Create the feature groups
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.
GetObject | Returns the object currently being edited by this builder.
SetFeatureTypes | Set the feature types to filter
SetInputFeatures | Set the list of input features
SetMachiningAccessDirections | Set the machining access directions to filter
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

GroupFeaturesFeaturesToGroupTypes Enumeration | Available types for the features to group

# Property Detail

## FeaturesToGroupType

`GroupFeatures.``FeaturesToGroupType`

  Returns or sets the features to group enumeration

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

  Getter Method

  Signature `FeaturesToGroupType`

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

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `FeaturesToGroupType`

  Parameters: | groupType (`NXOpen.CAM.GroupFeaturesFeaturesToGroupTypes`) –

  New in version NX9.0.0.

  License requirements: cam_base (“CAM BASE”)

## GeometryLocation

`GroupFeatures.``GeometryLocation`

  Returns or sets the geometry location

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

  Getter Method

  Signature `GeometryLocation`

  Returns: |
  Return type: | str

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `GeometryLocation`

  Parameters: | geometryLocation (str) –

  New in version NX9.0.0.

  License requirements: cam_base (“CAM BASE”)

## GroupByAttributes

`GroupFeatures.``GroupByAttributes`

  Returns or sets the group by attributes options - None, All, Predefined

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

  Getter Method

  Signature `GroupByAttributes`

  Returns: |
  Return type: | str

  New in version NX9.0.1.

  License requirements: None.

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

  Setter Method

  Signature `GroupByAttributes`

  Parameters: | groupBy (str) –

  New in version NX9.0.1.

  License requirements: cam_base (“CAM BASE”)

## GroupByIdenticalAttributes

`GroupFeatures.``GroupByIdenticalAttributes`

  Returns or sets the group by identical attributes flag

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

  Getter Method

  Signature `GroupByIdenticalAttributes`

  Returns: |
  Return type: | bool

  New in version NX9.0.0.

  Deprecated since version NX9.0.1: Use `CAM.GroupFeatures.GroupByAttributes`()` instead.

  License requirements: None.

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

  Setter Method

  Signature `GroupByIdenticalAttributes`

  Parameters: | enable (bool) –

  New in version NX9.0.0.

  Deprecated since version NX9.0.1: Use `CAM.GroupFeatures.GroupByAttributes`()` instead.

  License requirements: cam_base (“CAM BASE”)

## GroupByMachiningAccessDirection

`GroupFeatures.``GroupByMachiningAccessDirection`

  Returns or sets the group by machining access direction flag

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

  Getter Method

  Signature `GroupByMachiningAccessDirection`

  Returns: |
  Return type: | bool

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `GroupByMachiningAccessDirection`

  Parameters: | enable (bool) –

  New in version NX9.0.0.

  License requirements: cam_base (“CAM BASE”)

## TopFaceCollector

`GroupFeatures.``TopFaceCollector`

  Returns the top face collector

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

  Getter Method

  Signature `TopFaceCollector`

  Returns: |
  Return type: | `NXOpen.ScCollector`

  New in version NX9.0.0.

  License requirements: None.

# Method Detail

## CreateFeatureGroups

`GroupFeatures.``CreateFeatureGroups`

  Create the feature groups

  Signature `CreateFeatureGroups()`

  New in version NX9.0.0.

  License requirements: cam_base (“CAM BASE”)

## SetFeatureTypes

`GroupFeatures.``SetFeatureTypes`

  Set the feature types to filter

  Signature `SetFeatureTypes(ftrTypes)`

  Parameters: | ftrTypes (list of str) –

  New in version NX9.0.0.

  License requirements: cam_base (“CAM BASE”)

## SetInputFeatures

`GroupFeatures.``SetInputFeatures`

  Set the list of input features

  Signature `SetInputFeatures(ftrs)`

  Parameters: | ftrs (list of `NXOpen.CAM.CAMFeature`) –

  New in version NX9.0.0.

  License requirements: cam_base (“CAM BASE”)

## SetMachiningAccessDirections

`GroupFeatures.``SetMachiningAccessDirections`

  Set the machining access directions to filter

  Signature `SetMachiningAccessDirections(vecDirectionTags, dTolerance)`

  Parameters:

  - vecDirectionTags (list of `NXOpen.Direction`) –
  - dTolerance (float) –

  New in version NX9.0.0.

  License requirements: cam_base (“CAM BASE”)

## Validate

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