CouplingBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# CouplingBuilder Class

class `NXOpen.Mechatronics.``CouplingBuilder`

  Bases: `NXOpen.Mechatronics.PhysicsConstraintBuilder`

  This is an abstract class, and cannot be created.

  This is an abstract class, and cannot be created.

  New in version NX7.5.1.

# Properties

Property | Description
--- | ---
AllowSlip | Returns or sets the coulping can slip or not.
MasterAxisJoint | Returns the master axis joint.
Name | Returns or sets the name.
SlaveAxisJoint | Returns the slave axis joint.
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.
SetMasterAxisJoint | Sets the master axis.
SetSlaveAxisJoint | Sets the slave axis.
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

## AllowSlip

`CouplingBuilder.``AllowSlip`

  Returns or sets the coulping can slip or not.

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

  Getter Method

  Signature `AllowSlip`

  Returns: |
  Return type: | bool

  New in version NX7.5.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

  Setter Method

  Signature `AllowSlip`

  Parameters: | allowSlip (bool) –

  New in version NX7.5.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## MasterAxisJoint

`CouplingBuilder.``MasterAxisJoint`

  Returns the master axis joint.

  This can be a `NXOpen.Mechatronics.HingeJoint`, `NXOpen.Mechatronics.SlidingJoint` and `NXOpen.Mechatronics.CylindricalJoint`.

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

  Getter Method

  Signature `MasterAxisJoint`

  Returns: |
  Return type: | `NXOpen.Mechatronics.SelectPhysicsJoint`

  New in version NX7.5.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## SlaveAxisJoint

`CouplingBuilder.``SlaveAxisJoint`

  Returns the slave axis joint.

  This can be a `NXOpen.Mechatronics.HingeJoint`, `NXOpen.Mechatronics.SlidingJoint` and `NXOpen.Mechatronics.CylindricalJoint`.

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

  Getter Method

  Signature `SlaveAxisJoint`

  Returns: |
  Return type: | `NXOpen.Mechatronics.SelectPhysicsJoint`

  New in version NX7.5.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

# Method Detail

## SetMasterAxisJoint

`CouplingBuilder.``SetMasterAxisJoint`

  Sets the master axis.

  Signature `SetMasterAxisJoint(master)`

  Parameters: | master (`NXOpen.Mechatronics.PhysicsJoint`) –

  New in version NX8.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## SetSlaveAxisJoint

`CouplingBuilder.``SetSlaveAxisJoint`

  Sets the slave axis.

  Signature `SetSlaveAxisJoint(slave)`

  Parameters: | slave (`NXOpen.Mechatronics.PhysicsJoint`) –

  New in version NX8.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## Validate

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