ChainJointBuilder Class¶
-
class
NXOpen.Mechatronics.
ChainJointBuilder
¶ Bases:
NXOpen.Builder
Represents a
NXOpen.Mechatronics.ChainJointBuilder
.When
Builder.Commit()
is called None will be returned.To create a new instance of this class, use
NXOpen.Mechatronics.PhysicsManager.CreateChainJointBuilder()
New in version NX12.0.0.
Properties¶
Property | Description |
---|---|
AnchorPointSecond | Returns or sets the second anchor point. |
AngularLowerLimit | Returns the angular lower limit. |
AngularUpperLimit | Returns the angular upper limit. |
BaseAnchorPoint | Returns or sets the anchor point. |
BaseAxisVector | Returns or sets the axis vector. |
EnableAngularLowerLimit | Returns or sets the angular lower limit option. |
EnableAngularUpperLimit | Returns or sets the angular upper limit option. |
EnableSecondAnchor | Returns or sets the second anchor point option. |
Geometry | Returns the geometries. |
Name | Returns or sets the name. |
StartAngle | Returns the start angle. |
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¶
AnchorPointSecond¶
-
ChainJointBuilder.
AnchorPointSecond
¶ Returns or sets the second anchor point.
-------------------------------------
Getter Method
Signature
AnchorPointSecond
Returns: Return type: NXOpen.Point
New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
AnchorPointSecond
Parameters: anchorPoint ( NXOpen.Point
) –New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
AngularLowerLimit¶
-
ChainJointBuilder.
AngularLowerLimit
¶ Returns the angular lower limit.
The lower limit setup for joint angular movement.
-------------------------------------
Getter Method
Signature
AngularLowerLimit
Returns: Return type: NXOpen.Expression
New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
AngularUpperLimit¶
-
ChainJointBuilder.
AngularUpperLimit
¶ Returns the angular upper limit.
The upper limit setup for joint angular movement.
-------------------------------------
Getter Method
Signature
AngularUpperLimit
Returns: Return type: NXOpen.Expression
New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
BaseAnchorPoint¶
-
ChainJointBuilder.
BaseAnchorPoint
¶ Returns or sets the anchor point.
-------------------------------------
Getter Method
Signature
BaseAnchorPoint
Returns: Return type: NXOpen.Point
New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
BaseAnchorPoint
Parameters: point ( NXOpen.Point
) –New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
BaseAxisVector¶
-
ChainJointBuilder.
BaseAxisVector
¶ Returns or sets the axis vector.
-------------------------------------
Getter Method
Signature
BaseAxisVector
Returns: Return type: NXOpen.Direction
New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
BaseAxisVector
Parameters: axisVector ( NXOpen.Direction
) –New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
EnableAngularLowerLimit¶
-
ChainJointBuilder.
EnableAngularLowerLimit
¶ Returns or sets the angular lower limit option.
If the enable is true, then this joint will be applied the lower limit in angular direction.
-------------------------------------
Getter Method
Signature
EnableAngularLowerLimit
Returns: Return type: bool New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
EnableAngularLowerLimit
Parameters: enable (bool) – New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
EnableAngularUpperLimit¶
-
ChainJointBuilder.
EnableAngularUpperLimit
¶ Returns or sets the angular upper limit option.
If the enable is true, then this joint will be applied the upper limit in angular direction.
-------------------------------------
Getter Method
Signature
EnableAngularUpperLimit
Returns: Return type: bool New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
EnableAngularUpperLimit
Parameters: enable (bool) – New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
EnableSecondAnchor¶
-
ChainJointBuilder.
EnableSecondAnchor
¶ Returns or sets the second anchor point option.
-------------------------------------
Getter Method
Signature
EnableSecondAnchor
Returns: Return type: bool New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
EnableSecondAnchor
Parameters: enable (bool) – New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
Geometry¶
-
ChainJointBuilder.
Geometry
¶ Returns the geometries.
This can be a
NXOpen.Assemblies.ComponentAssembly
orNXOpen.Mechatronics.RigidBody
-------------------------------------
Getter Method
Signature
Geometry
Returns: Return type: NXOpen.SelectNXObjectList
New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
Name¶
-
ChainJointBuilder.
Name
¶ Returns or sets the name.
-------------------------------------
Getter Method
Signature
Name
Returns: Return type: str New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
Name
Parameters: name (str) – New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
StartAngle¶
-
ChainJointBuilder.
StartAngle
¶ Returns the start angle.
-------------------------------------
Getter Method
Signature
StartAngle
Returns: Return type: NXOpen.Expression
New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
Method Detail¶
Validate¶
-
ChainJointBuilder.
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.