NcmOptimizeGroup Class — NXOpen Python API Reference 12.0.0 documentation

# NcmOptimizeGroup Class

class `NXOpen.CAM.``NcmOptimizeGroup`

  Bases: `NXOpen.CAM.NcmSubopBuilder`

  Represents a `CAM.NcmOptimizeGroup`

  New in version NX10.0.1.

# Properties

Property | Description
--- | ---
CollisionCheck | Returns or sets the collision check activation
DefaultRegionStartType | Returns or sets the region start type
NcmSmoothing | Returns the non cutting smoothing
StartPointsEffectDistBuilder | Returns the region start points effective distance builder (inheritable tool dep)
StartPointsUseEffectDist | Returns or sets the start points use effective distance
Tag | Returns the Tag for this object.
TransferAvoidanceFrom | Returns the from point builder
TransferAvoidanceGohome | Returns the gohome point builder
TransferAvoidanceReturn | Returns the return point builder
TransferAvoidanceStart | Returns the start point builder
TransferBetweenRegions | Returns the transfer between regions
TransferClearance | Returns the clearance setting
TransferInitialFinal | Returns the transfer settings for initial and final

# Methods

Method | Description
--- | ---
GetCustomizableItemBuilder | Returns the customizable item builder for given customizable item name
GetCustomizableItemNames | Returns the names for all customizable item ids
GetRegionStartPoints | Returns region start points
SetRegionStartPoints | Sets region start points
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Property Detail

## CollisionCheck

`NcmOptimizeGroup.``CollisionCheck`

  Returns or sets the collision check activation

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

  Getter Method

  Signature `CollisionCheck`

  Returns: |
  Return type: | bool

  New in version NX10.0.1.

  License requirements: None.

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

  Setter Method

  Signature `CollisionCheck`

  Parameters: | newValue (bool) –

  New in version NX10.0.1.

  License requirements: cam_base (“CAM BASE”)

## NcmSmoothing

`NcmOptimizeGroup.``NcmSmoothing`

  Returns the non cutting smoothing

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

  Getter Method

  Signature `NcmSmoothing`

  Returns: | The non cutting smoothing
  Return type: | `NXOpen.CAM.NcmSmoothingBuilder`

  New in version NX10.0.3.

  License requirements: None.

## TransferAvoidanceFrom

`NcmOptimizeGroup.``TransferAvoidanceFrom`

  Returns the from point builder

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

  Getter Method

  Signature `TransferAvoidanceFrom`

  Returns: | The from point builder
  Return type: | `NXOpen.CAM.NcmAvoidancePointBuilder`

  New in version NX10.0.1.

  License requirements: None.

## TransferAvoidanceGohome

`NcmOptimizeGroup.``TransferAvoidanceGohome`

  Returns the gohome point builder

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

  Getter Method

  Signature `TransferAvoidanceGohome`

  Returns: | The gohome point builder
  Return type: | `NXOpen.CAM.NcmAvoidancePointBuilder`

  New in version NX10.0.1.

  License requirements: None.

## TransferAvoidanceReturn

`NcmOptimizeGroup.``TransferAvoidanceReturn`

  Returns the return point builder

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

  Getter Method

  Signature `TransferAvoidanceReturn`

  Returns: | The return point builder
  Return type: | `NXOpen.CAM.NcmAvoidancePointBuilder`

  New in version NX10.0.1.

  License requirements: None.

## TransferAvoidanceStart

`NcmOptimizeGroup.``TransferAvoidanceStart`

  Returns the start point builder

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

  Getter Method

  Signature `TransferAvoidanceStart`

  Returns: | The start point builder
  Return type: | `NXOpen.CAM.NcmAvoidancePointBuilder`

  New in version NX10.0.1.

  License requirements: None.

## TransferBetweenRegions

`NcmOptimizeGroup.``TransferBetweenRegions`

  Returns the transfer between regions

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

  Getter Method

  Signature `TransferBetweenRegions`

  Returns: | Transfer Between Regions
  Return type: | `NXOpen.CAM.NcmTransfer`

  New in version NX10.0.1.

  License requirements: None.

## TransferClearance

`NcmOptimizeGroup.``TransferClearance`

  Returns the clearance setting

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

  Getter Method

  Signature `TransferClearance`

  Returns: | The clearance builder
  Return type: | `NXOpen.CAM.NcmClearanceBuilder`

  New in version NX10.0.1.

  License requirements: None.

## TransferInitialFinal

`NcmOptimizeGroup.``TransferInitialFinal`

  Returns the transfer settings for initial and final

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

  Getter Method

  Signature `TransferInitialFinal`

  Returns: | The transfer types builder
  Return type: | `NXOpen.CAM.NcmTransferTypes`

  New in version NX10.0.1.

  License requirements: None.

# Method Detail

## Validate

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