BreakingConstraintBuilder Class

class NXOpen.Mechatronics.BreakingConstraintBuilder

Bases: NXOpen.Mechatronics.PhysicsConstraintBuilder

Represents a NXOpen.Mechatronics.BreakingConstraint builder.

To create a new instance of this class, use NXOpen.Mechatronics.BreakingConstraintCollection.CreateBreakingConstraintBuilder()

New in version NX7.5.1.

Properties

Property Description
BreakingMode Returns or sets the breaking mode.
Direction Returns or sets the direction.
FixedDirection Returns or sets the direction is fixed or not.
Joint Returns the joint object.
MaximumMagnitude Returns the maximum allowable magnitude, the joint will be broken if it exceeds this value.
Name Returns or sets the name.
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.
SetJoint Sets the joint.
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

BreakingConstraintBuilderBreakingModeType Enumeration Represents the breaking mode.

Property Detail

BreakingMode

BreakingConstraintBuilder.BreakingMode

Returns or sets the breaking mode.

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

Getter Method

Signature BreakingMode

Returns:
Return type:NXOpen.Mechatronics.BreakingConstraintBuilderBreakingModeType

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature BreakingMode

Parameters:breakingMode (NXOpen.Mechatronics.BreakingConstraintBuilderBreakingModeType) –

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Direction

BreakingConstraintBuilder.Direction

Returns or sets the direction.

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

Getter Method

Signature Direction

Returns:
Return type:NXOpen.Direction

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature Direction

Parameters:direction (NXOpen.Direction) –

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

FixedDirection

BreakingConstraintBuilder.FixedDirection

Returns or sets the direction is fixed or not.

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

Getter Method

Signature FixedDirection

Returns:
Return type:bool

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature FixedDirection

Parameters:fixedDirection (bool) –

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Joint

BreakingConstraintBuilder.Joint

Returns the joint object.

It can be any type of joints.

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

Getter Method

Signature Joint

Returns:
Return type:NXOpen.Mechatronics.SelectPhysicsJoint

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

MaximumMagnitude

BreakingConstraintBuilder.MaximumMagnitude

Returns the maximum allowable magnitude, the joint will be broken if it exceeds this value.

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

Getter Method

Signature MaximumMagnitude

Returns:
Return type:NXOpen.Expression

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Method Detail

SetJoint

BreakingConstraintBuilder.SetJoint

Sets the joint.

Signature SetJoint(joint)

Parameters:joint (NXOpen.Mechatronics.PhysicsJoint) –

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Validate

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