PartModuleInputBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# PartModuleInputBuilder Class

class `NXOpen.GeometricUtilities.``PartModuleInputBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.GeometricUtilities.PartModuleInputBuilder`

  To create a new instance of this class, use `NXOpen.Features.PartModule.CreatePartModuleInputBuilder()`

  Default values.

  Property | Value
  --- | ---
  InputReferences.ObjectType | BodyCollector
  ModifiableGeometryOption | WholeBody

  New in version NX9.0.0.

# Properties

Property | Description
--- | ---
DefineSharedBodyInput | Returns or sets the shared body inputs option.
InputReferences | Returns the part module input data
ModifiableGeometry | Returns the faces/edges specified as modifiable geometry
ModifiableGeometryOption | Returns or sets the Modifiable Geometry option
SharedBodyInput | Returns the bodies for part module shared body
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.
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.

# Enumerations

PartModuleInputBuilderModifiableGeometryOptions Enumeration | the Modifiable Geometry option types

# Property Detail

## DefineSharedBodyInput

`PartModuleInputBuilder.``DefineSharedBodyInput`

  Returns or sets the shared body inputs option.

  If true, user will be able to provide shared body inputs.

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

  Getter Method

  Signature `DefineSharedBodyInput`

  Returns: |
  Return type: | bool

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `DefineSharedBodyInput`

  Parameters: | defineSharedBodyInput (bool) –

  New in version NX9.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## InputReferences

`PartModuleInputBuilder.``InputReferences`

  Returns the part module input data

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

  Getter Method

  Signature `InputReferences`

  Returns: |
  Return type: | `NXOpen.Features.PartGeometryCopyBuilder`

  New in version NX9.0.0.

  License requirements: None.

## ModifiableGeometry

`PartModuleInputBuilder.``ModifiableGeometry`

  Returns the faces/edges specified as modifiable geometry

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

  Getter Method

  Signature `ModifiableGeometry`

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

  New in version NX9.0.0.

  License requirements: None.

## ModifiableGeometryOption

`PartModuleInputBuilder.``ModifiableGeometryOption`

  Returns or sets the Modifiable Geometry option

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

  Getter Method

  Signature `ModifiableGeometryOption`

  Returns: |
  Return type: | `NXOpen.GeometricUtilities.PartModuleInputBuilderModifiableGeometryOptions`

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ModifiableGeometryOption`

  Parameters: | modifiableGeometryOption (`NXOpen.GeometricUtilities.PartModuleInputBuilderModifiableGeometryOptions`) –

  New in version NX9.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## SharedBodyInput

`PartModuleInputBuilder.``SharedBodyInput`

  Returns the bodies for part module shared body

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

  Getter Method

  Signature `SharedBodyInput`

  Returns: |
  Return type: | `NXOpen.Features.PartGeometryCopyBuilder`

  New in version NX9.0.0.

  License requirements: None.

# Method Detail

## Validate

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