CouplerBuilder Class

class NXOpen.Motion.CouplerBuilder

Bases: NXOpen.Motion.MotionBuilder

Represents a NXOpen.Motion.CouplerBuilder

This is an abstract class, and cannot be created.

New in version NX6.0.0.

Properties

Property Description
ContactPoint Returns or sets the contact point
DisplayScale Returns or sets the icon display scale
FirstJoint Returns the first joint
FirstRadiusExpression Returns the first radius expression.
GroupName Returns or sets the group name
GroupType Returns or sets the group type
Name Returns or sets the name
RatioExpression Returns the ratio expression
SecondJoint Returns the second joint
SecondRadiusExpression Returns the second radius expression.
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

ContactPoint

CouplerBuilder.ContactPoint

Returns or sets the contact point

-------------------------------------

Getter Method

Signature ContactPoint

Returns:
Return type:NXOpen.Point

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ContactPoint

Parameters:contactPt (NXOpen.Point) –

New in version NX6.0.0.

License requirements: None.

FirstJoint

CouplerBuilder.FirstJoint

Returns the first joint

-------------------------------------

Getter Method

Signature FirstJoint

Returns:
Return type:NXOpen.Motion.SelectJoint

New in version NX6.0.0.

License requirements: None.

FirstRadiusExpression

CouplerBuilder.FirstRadiusExpression

Returns the first radius expression.

Only valid when using Simcenter Solver.

-------------------------------------

Getter Method

Signature FirstRadiusExpression

Returns:
Return type:NXOpen.Expression

New in version NX12.0.0.

License requirements: None.

Name

CouplerBuilder.Name

Returns or sets the name

-------------------------------------

Getter Method

Signature Name

Returns:
Return type:str

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Name

Parameters:name (str) –

New in version NX6.0.0.

License requirements: None.

RatioExpression

CouplerBuilder.RatioExpression

Returns the ratio expression

-------------------------------------

Getter Method

Signature RatioExpression

Returns:
Return type:NXOpen.Expression

New in version NX8.5.0.

License requirements: None.

SecondJoint

CouplerBuilder.SecondJoint

Returns the second joint

-------------------------------------

Getter Method

Signature SecondJoint

Returns:
Return type:NXOpen.Motion.SelectJoint

New in version NX6.0.0.

License requirements: None.

SecondRadiusExpression

CouplerBuilder.SecondRadiusExpression

Returns the second radius expression.

Only valid when using Simcenter Solver.

-------------------------------------

Getter Method

Signature SecondRadiusExpression

Returns:
Return type:NXOpen.Expression

New in version NX12.0.0.

License requirements: None.

Method Detail

Validate

CouplerBuilder.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.