PositioningGroupBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# PositioningGroupBuilder Class

class `NXOpen.Assemblies.``PositioningGroupBuilder`

  Bases: `NXOpen.Builder`

  Represents builder class for positioning group which is used to store constraints for design element.

  To create a new instance of this class, use `NXOpen.CollaborativeContentManager.CreatePositioningGroupBuilder()`

  Default values.

  Property | Value
  --- | ---
  MakeActive | 1

  New in version NX10.0.0.

# Properties

Property | Description
--- | ---
MakeActive | Returns or sets the option to specify whether a newly created positioning group should be made active after creation or not.
OwningPositioningTask | Returns or sets the owning positioning task.
PositioningGroupDataMembers | Returns the members for positioning group
PositioningGroupName | Returns or sets the name of positioning group.
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.

# Property Detail

## MakeActive

`PositioningGroupBuilder.``MakeActive`

  Returns or sets the option to specify whether a newly created positioning group should be made active after creation or not.

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

  Getter Method

  Signature `MakeActive`

  Returns: |
  Return type: | bool

  New in version NX10.0.0.

  License requirements: None.

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

  Setter Method

  Signature `MakeActive`

  Parameters: | makeActive (bool) –

  New in version NX10.0.0.

  License requirements: nx_4gd_integration (“4th Generation Design”)

## OwningPositioningTask

`PositioningGroupBuilder.``OwningPositioningTask`

  Returns or sets the owning positioning task.

  During creation set method should be called with the positioning task in which new `NXOpen.Assemblies.PositioningGroup` has to be created. During edit operation set method should not be called. An error would be raised if during edit operation set method is called with a positioning task which is different from the owning positioning task of `NXOpen.Assemblies.PositioningGroup`.

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

  Getter Method

  Signature `OwningPositioningTask`

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

  New in version NX10.0.0.

  License requirements: None.

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

  Setter Method

  Signature `OwningPositioningTask`

  Parameters: | positioningTask (`NXOpen.Assemblies.PositioningTask`) – This parameter may not be None.

  New in version NX10.0.0.

  License requirements: nx_4gd_integration (“4th Generation Design”)

## PositioningGroupDataMembers

`PositioningGroupBuilder.``PositioningGroupDataMembers`

  Returns the members for positioning group

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

  Getter Method

  Signature `PositioningGroupDataMembers`

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

  New in version NX10.0.0.

  License requirements: None.

## PositioningGroupName

`PositioningGroupBuilder.``PositioningGroupName`

  Returns or sets the name of positioning group.

  The user of this API is responcible to free the text pointer

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

  Getter Method

  Signature `PositioningGroupName`

  Returns: |
  Return type: | str

  New in version NX10.0.0.

  License requirements: None.

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

  Setter Method

  Signature `PositioningGroupName`

  Parameters: | nameOfPositioningGroup (str) –

  New in version NX10.0.0.

  License requirements: nx_4gd_integration (“4th Generation Design”)

# Method Detail

## Validate

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