LoadInterpartDataBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# LoadInterpartDataBuilder Class

class `NXOpen.Assemblies.``LoadInterpartDataBuilder`

  Bases: `NXOpen.Builder`

  Represents a builder:py:class:NXOpen.Assemblies.LoadInterpartDataBuilder

  To create a new instance of this class, use `NXOpen.Assemblies.AssemblyManager.CreateLoadInterpartDataBuilder()`

  Default values.

  Property | Value
  --- | ---
  OpenUnloadedParents | None
  SelectionScope | AllPartsInDisplayedAssembly

  New in version NX6.0.0.

# Properties

Property | Description
--- | ---
OpenUnloadedParents | Returns or sets the open unloaded parents level type
SelectionScope | Returns or sets the selection scope type
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.
GetFailedParts | Returns an array of the parts that failed to load and update
GetLoadInterpartDataStatus | Returns part load status and delayed update status for the part which failed to load and update
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

LoadInterpartDataBuilderOpenUnloadedParentsType Enumeration | Represents the load interpart parent level types
LoadInterpartDataBuilderSelectionScopeType Enumeration | Represents the load interpart selection scope types

# Property Detail

## OpenUnloadedParents

`LoadInterpartDataBuilder.``OpenUnloadedParents`

  Returns or sets the open unloaded parents level type

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

  Getter Method

  Signature `OpenUnloadedParents`

  Returns: |
  Return type: | `NXOpen.Assemblies.LoadInterpartDataBuilderOpenUnloadedParentsType`

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `OpenUnloadedParents`

  Parameters: | openUnloadedParents (`NXOpen.Assemblies.LoadInterpartDataBuilderOpenUnloadedParentsType`) –

  New in version NX6.0.0.

  License requirements: wave (“WAVE FUNCTIONALITY”)

## SelectionScope

`LoadInterpartDataBuilder.``SelectionScope`

  Returns or sets the selection scope type

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

  Getter Method

  Signature `SelectionScope`

  Returns: |
  Return type: | `NXOpen.Assemblies.LoadInterpartDataBuilderSelectionScopeType`

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SelectionScope`

  Parameters: | selectionScope (`NXOpen.Assemblies.LoadInterpartDataBuilderSelectionScopeType`) –

  New in version NX6.0.0.

  License requirements: wave (“WAVE FUNCTIONALITY”)

# Method Detail

## GetFailedParts

`LoadInterpartDataBuilder.``GetFailedParts`

  Returns an array of the parts that failed to load and update

  Signature `GetFailedParts()`

  Returns: | Array of the part tags failed to

  load and update :rtype: list of `NXOpen.BasePart`

  New in version NX6.0.0.

  License requirements: None.

## GetLoadInterpartDataStatus

`LoadInterpartDataBuilder.``GetLoadInterpartDataStatus`

  Returns part load status and delayed update status for the part which failed to load and update

  Signature `GetLoadInterpartDataStatus(part)`

  Parameters: | part (`NXOpen.BasePart`) – Failed part tag
  Returns: | a tuple
  Return type: | A tuple consisting of (loadStatus, delayedUpdateStatus). loadStatus is a `NXOpen.PartLoadStatus`. Part load status for the failed partdelayedUpdateStatus is a `NXOpen.PartDelayedUpdateStatus`. Delayed update status data status for the failed part

  New in version NX6.0.0.

  License requirements: None.

## Validate

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