ForceTorqueControlBuilder Class¶
-
class
NXOpen.Mechatronics.
ForceTorqueControlBuilder
¶ Bases:
NXOpen.Mechatronics.PhysicsConstraintBuilder
ForceTorque control builder for building a ForceTorque object.
To create a new instance of this class, use
NXOpen.Mechatronics.ForceTorqueControlCollection.CreateForceTorqueControlBuilder()
New in version NX11.0.0.
Properties¶
Property | Description |
---|---|
AxisJoint | Returns the joint select. This can be a NXOpen.Mechatronics.HingeJoint , NXOpen.Mechatronics.SlidingJoint , NXOpen.Mechatronics.CylindricalJoint and NXOpen.Mechatronics.TransportSurface . |
AxisType | Returns or sets a value that indicates which type of axis joint. |
ForceTorque | Returns the value that indicates the value for force/torque for the control. |
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. |
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¶
ForceTorqueControlBuilderAxisJointType Enumeration | The axis type for ForceTorque control. |
Property Detail¶
AxisJoint¶
-
ForceTorqueControlBuilder.
AxisJoint
¶ Returns the joint select. This can be a
NXOpen.Mechatronics.HingeJoint
,NXOpen.Mechatronics.SlidingJoint
,NXOpen.Mechatronics.CylindricalJoint
andNXOpen.Mechatronics.TransportSurface
.-------------------------------------
Getter Method
Signature
AxisJoint
Returns: Return type: NXOpen.Mechatronics.SelectPhysicsJoint
New in version NX11.0.0.
License requirements: None.
AxisType¶
-
ForceTorqueControlBuilder.
AxisType
¶ Returns or sets a value that indicates which type of axis joint.
-------------------------------------
Getter Method
Signature
AxisType
Returns: Return type: NXOpen.Mechatronics.ForceTorqueControlBuilderAxisJointType
New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AxisType
Parameters: axisType ( NXOpen.Mechatronics.ForceTorqueControlBuilderAxisJointType
) –New in version NX11.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
ForceTorque¶
-
ForceTorqueControlBuilder.
ForceTorque
¶ Returns the value that indicates the value for force/torque for the control.
-------------------------------------
Getter Method
Signature
ForceTorque
Returns: Return type: NXOpen.Expression
New in version NX11.0.0.
License requirements: None.
Method Detail¶
Validate¶
-
ForceTorqueControlBuilder.
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.