ScrewJointBuilder Class

class NXOpen.Mechatronics.ScrewJointBuilder

Bases: NXOpen.Mechatronics.PhysicsJointBuilder

Represents a NXOpen.Mechatronics.ScrewJoint builder.

To create a new instance of this class, use NXOpen.Mechatronics.ScrewJointCollection.CreateScrewJointBuilder()

New in version NX11.0.0.

Properties

Property Description
Attachment Returns the attachment of joint.
AxisVector
Returns or sets a value that specifies axis vector.
Base Returns the base of joint.
ExpressionRatio
Returns a value that indicates ratio value for the screw joint.
Name Returns or sets the name.
PointOrigin
Returns or sets a value that indicates the origin point.
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.
SetAttachment Sets the attachment.
SetBase Sets the base.
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

AxisVector

ScrewJointBuilder.AxisVector

Returns or sets a value that specifies axis vector.

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

Getter Method

Signature AxisVector()

Returns:
Return type:NXOpen.Direction

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature AxisVector(axisVector)

Parameters:axisVector (NXOpen.Direction) –

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

ExpressionRatio

ScrewJointBuilder.ExpressionRatio

Returns a value that indicates ratio value for the screw joint.

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

Getter Method

Signature ExpressionRatio()

Returns:
Return type:NXOpen.Expression

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

PointOrigin

ScrewJointBuilder.PointOrigin

Returns or sets a value that indicates the origin point.

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

Getter Method

Signature PointOrigin()

Returns:
Return type:NXOpen.Point

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature PointOrigin(origin)

Parameters:origin (NXOpen.Point) –

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Method Detail

Validate

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