AssembliesParameterPropertiesBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# AssembliesParameterPropertiesBuilder Class

class `NXOpen.Assemblies.``AssembliesParameterPropertiesBuilder`

  Bases: `NXOpen.Builder`

  Represents an `NXOpen.Assemblies.AssembliesParameterPropertiesBuilder` to be used for changing the name or modifying the positioning mixture status of a component.

  To create a new instance of this class, use `NXOpen.PropertiesManager.CreateAssembliesParameterPropertiesBuilder()`

  Default values.

  Property | Value
  --- | ---
  Arrangements | IndividuallyPositioned

  New in version NX8.0.0.

# Properties

Property | Description
--- | ---
Arrangements | Returns or sets the arrangements.
SelectedObjects | Returns the selected object(s) list.
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

AssembliesParameterPropertiesBuilderArrangementOptions Enumeration | The positioning mixture status options

# Property Detail

## Arrangements

`AssembliesParameterPropertiesBuilder.``Arrangements`

  Returns or sets the arrangements.

  The positioning mixture status for the selected components. No action will take place if Mixed is set as the arrangement option.

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

  Getter Method

  Signature `Arrangements`

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

  New in version NX8.0.0.

  License requirements: assemblies (“ASSEMBLIES MODULE”)

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

  Setter Method

  Signature `Arrangements`

  Parameters: | arrangements (`NXOpen.Assemblies.AssembliesParameterPropertiesBuilderArrangementOptions`) –

  New in version NX8.0.0.

  License requirements: assemblies (“ASSEMBLIES MODULE”)

## SelectedObjects

`AssembliesParameterPropertiesBuilder.``SelectedObjects`

  Returns the selected object(s) list.

  This is the active list of components that will be modified by any parameter changes.

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

  Getter Method

  Signature `SelectedObjects`

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

  New in version NX8.0.0.

  License requirements: assemblies (“ASSEMBLIES MODULE”)

# Method Detail

## Validate

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