KinematicChain Class¶
-
class
NXOpen.SIM.KinematicChain¶ Bases:
NXOpen.BuilderThis class is used for add kinematic chain to the list.
Calling
Builder.Commiton this builder will only return None.To create a new instance of this class, use
NXOpen.SIM.KinematicConfigurator.CreateKinematicChainNew in version NX9.0.0.
Properties¶
| Property | Description |
|---|---|
| Axial | Returns or sets the axial axis of the kinematic chain |
| CoordinateAxes | Returns or sets the coordinate axes name of the kinematic chain |
| CoordinatePlane | Returns or sets the coordinate plane type of the kinematic chain |
| Device | Returns or sets the device component of the kinematic chain |
| Name | Returns or sets the name of the kinematic chain |
| Radial | Returns or sets the radial axis of the kinematic chain |
| ReferencePointJunction | Returns or sets the reference point junction of the kinematic chain |
| Rotary1 | Returns or sets the rotary1 axis of the kinematic chain |
| Rotary2 | Returns or sets the rotary2 axis of the kinematic chain |
| Rotary3 | Returns or sets the rotary3 axis of the kinematic chain |
| Rotary4 | Returns or sets the rotary4 axis of the kinematic chain |
| Rotary5 | Returns or sets the rotary5 axis of the kinematic chain |
| Rotary6 | Returns or sets the rotary6 axis of the kinematic chain |
| Setup | Returns or sets the setup component of the kinematic chain |
| Tag | Returns the Tag for this object. |
| Type | Returns or sets the type of the kinematic chain |
| NXOpen.SIM.KinematicChain.X | Returns or sets the X axis of the kinematic chain |
| NXOpen.SIM.KinematicChain.Y | Returns or sets the Y axis of the kinematic chain |
| NXOpen.SIM.KinematicChain.Z | Returns or sets the Z axis of the kinematic chain |
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¶
| KinematicChainCoordinatePlaneTypes Enumeration | Represents the coordinate plane type |
| KinematicChainTypes Enumeration | Represents the kinematic chain type |
Property Detail¶
Axial¶
-
KinematicChain.Axial¶ Returns or sets the axial axis of the kinematic chain
-------------------------------------Getter Method
Signature
Axial()Returns: the axial axis Return type: str New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Axial(axis)Parameters: axis (str) – the axial axis New in version NX9.0.0.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
CoordinateAxes¶
-
KinematicChain.CoordinateAxes¶ Returns or sets the coordinate axes name of the kinematic chain
-------------------------------------Getter Method
Signature
CoordinateAxes()Returns: the coordinate axes Return type: str New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CoordinateAxes(axis)Parameters: axis (str) – the coordinate axes New in version NX9.0.0.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
CoordinatePlane¶
-
KinematicChain.CoordinatePlane¶ Returns or sets the coordinate plane type of the kinematic chain
-------------------------------------Getter Method
Signature
CoordinatePlane()Returns: the coordinate plane type Return type: NXOpen.SIM.KinematicChainCoordinatePlaneTypesNew in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CoordinatePlane(type)Parameters: type ( NXOpen.SIM.KinematicChainCoordinatePlaneTypes) – the coordinate plane typeNew in version NX9.0.0.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
Device¶
-
KinematicChain.Device¶ Returns or sets the device component of the kinematic chain
-------------------------------------Getter Method
Signature
Device()Returns: the chain device Return type: str New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Device(device)Parameters: device (str) – the chain device New in version NX9.0.0.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
Name¶
-
KinematicChain.Name¶ Returns or sets the name of the kinematic chain
-------------------------------------Getter Method
Signature
Name()Returns: The chain’s name Return type: str New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Name(name)Parameters: name (str) – the chain’s new name New in version NX9.0.0.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
Radial¶
-
KinematicChain.Radial¶ Returns or sets the radial axis of the kinematic chain
-------------------------------------Getter Method
Signature
Radial()Returns: the radial axis Return type: str New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Radial(axis)Parameters: axis (str) – the radial axis New in version NX9.0.0.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
ReferencePointJunction¶
-
KinematicChain.ReferencePointJunction¶ Returns or sets the reference point junction of the kinematic chain
-------------------------------------Getter Method
Signature
ReferencePointJunction()Returns: the reference point junction Return type: str New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ReferencePointJunction(refPointJunction)Parameters: refPointJunction (str) – the reference point junction New in version NX9.0.0.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
Rotary1¶
-
KinematicChain.Rotary1¶ Returns or sets the rotary1 axis of the kinematic chain
-------------------------------------Getter Method
Signature
Rotary1()Returns: the rotary1 Return type: str New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Rotary1(rotary1)Parameters: rotary1 (str) – the rotary1 New in version NX9.0.0.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
Rotary2¶
-
KinematicChain.Rotary2¶ Returns or sets the rotary2 axis of the kinematic chain
-------------------------------------Getter Method
Signature
Rotary2()Returns: the rotary2 Return type: str New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Rotary2(rotary2)Parameters: rotary2 (str) – the rotary2 New in version NX9.0.0.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
Rotary3¶
-
KinematicChain.Rotary3¶ Returns or sets the rotary3 axis of the kinematic chain
-------------------------------------Getter Method
Signature
Rotary3()Returns: the rotary3 Return type: str New in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Rotary3(rotary3)Parameters: rotary3 (str) – the rotary3 New in version NX10.0.0.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
Rotary4¶
-
KinematicChain.Rotary4¶ Returns or sets the rotary4 axis of the kinematic chain
-------------------------------------Getter Method
Signature
Rotary4()Returns: the rotary4 Return type: str New in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Rotary4(rotary4)Parameters: rotary4 (str) – the rotary4 New in version NX10.0.0.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
Rotary5¶
-
KinematicChain.Rotary5¶ Returns or sets the rotary5 axis of the kinematic chain
-------------------------------------Getter Method
Signature
Rotary5()Returns: the rotary5 Return type: str New in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Rotary5(rotary5)Parameters: rotary5 (str) – the rotary5 New in version NX10.0.0.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
Rotary6¶
-
KinematicChain.Rotary6¶ Returns or sets the rotary6 axis of the kinematic chain
-------------------------------------Getter Method
Signature
Rotary6()Returns: the rotary6 Return type: str New in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Rotary6(rotary6)Parameters: rotary6 (str) – the rotary6 New in version NX10.0.0.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
Setup¶
-
KinematicChain.Setup¶ Returns or sets the setup component of the kinematic chain
-------------------------------------Getter Method
Signature
Setup()Returns: the chain setup Return type: str New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Setup(setup)Parameters: setup (str) – the chain setup New in version NX9.0.0.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
Type¶
-
KinematicChain.Type¶ Returns or sets the type of the kinematic chain
-------------------------------------Getter Method
Signature
Type()Returns: the chain type Return type: NXOpen.SIM.KinematicChainTypesNew in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Type(chainType)Parameters: chainType ( NXOpen.SIM.KinematicChainTypes) – the chain typeNew in version NX9.0.0.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
X¶
-
KinematicChain.X¶ Returns or sets the X axis of the kinematic chain
-------------------------------------Getter Method
Signature
X()Returns: the x axis Return type: str New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
X(xAxis)Parameters: xAxis (str) – the x axis New in version NX9.0.0.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
Y¶
-
KinematicChain.Y¶ Returns or sets the Y axis of the kinematic chain
-------------------------------------Getter Method
Signature
Y()Returns: the Y axis Return type: str New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Y(yAxis)Parameters: yAxis (str) – the Y axis New in version NX9.0.0.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
Z¶
-
KinematicChain.Z¶ Returns or sets the Z axis of the kinematic chain
-------------------------------------Getter Method
Signature
Z()Returns: the z axis Return type: str New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Z(zAxis)Parameters: zAxis (str) – the z axis New in version NX9.0.0.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
Method Detail¶
Validate¶
-
KinematicChain.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.