NCGroupBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# NCGroupBuilder Class

class `NXOpen.CAM.``NCGroupBuilder`

  Bases: `NXOpen.CAM.ParamBuilder`

  Represents a NCGroup Builder

  This is an abstract class, and cannot be instantiated.

  New in version NX7.5.0.

# Properties

Property | Description
--- | ---
CycleEvent | Returns the cycle event
CycleTable | Returns the cycle
Description | Returns or sets the description
EndUdeSet | Returns the end ude set
OptimizationMethod | Returns or sets the optim method
StartUdeSet | Returns the start ude set
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to 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.
GetCustomizableItemBuilder | Returns the customizable item builder for the given customizable item name
GetCustomizableItemNames | Returns the names for all customizable item ids
GetObject | Returns the object currently being edited by this builder.
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.

# Property Detail

## Description

`NCGroupBuilder.``Description`

  Returns or sets the description

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

  Getter Method

  Signature `Description`

  Returns: | the description
  Return type: | str

  New in version NX9.0.0.

  License requirements: cam_base (“CAM BASE”)

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

  Setter Method

  Signature `Description`

  Parameters: | description (str) – the description

  New in version NX9.0.0.

  License requirements: cam_base (“CAM BASE”)

## EndUdeSet

`NCGroupBuilder.``EndUdeSet`

  Returns the end ude set

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

  Getter Method

  Signature `EndUdeSet`

  Returns: | the end ude set
  Return type: | `NXOpen.CAM.UdeSet`

  New in version NX7.5.0.

  License requirements: None.

## StartUdeSet

`NCGroupBuilder.``StartUdeSet`

  Returns the start ude set

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

  Getter Method

  Signature `StartUdeSet`

  Returns: | the start ude set
  Return type: | `NXOpen.CAM.UdeSet`

  New in version NX7.5.0.

  License requirements: None.

# Method Detail

## Validate

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