KinematicChannelBuilder Class¶
-
class
NXOpen.SIM.KinematicChannelBuilder¶ Bases:
NXOpen.TaggedObject,NXOpen.GeometricUtilities.IComponentBuilderThis class is used for add kinematic channel to the channel configuratation list.
Calling
Builder.Commit()on this builder will only return None.To create a new instance of this class, use
NXOpen.SIM.KinematicConfigurator.CreateKinematicChannelBuilder()New in version NX9.0.3.
Properties¶
| Property | Description |
|---|---|
| GeometryAxisX | Returns or sets the geometry X axis of the channel |
| GeometryAxisY | Returns or sets the geometry Y axis of the channel |
| GeometryAxisZ | Returns or sets the geometry Z axis of the channel |
| MainSpindle | Returns or sets the main spindle of the channel |
| Name | Returns or sets the name of the channel |
| Tag | Returns the Tag for this object. |
Methods¶
| Method | Description |
|---|---|
| GetAssignedAxes | Gets a list of assigned axes of the channel |
| GetReferencedSpindles | Gets a list of referenced spindles of the channel |
| SetAssignedAxes | Sets a list of assigned axes of the channel |
| SetAssignedAxis | Sets an assigned axis of the channel |
| SetReferencedSpindle | Sets a referenced spindle of the channel |
| SetReferencedSpindles | Sets a list of referenced spindles of the channel |
| SetUnassignedAxis | Sets an unassigned axis of the channel |
| SetUnreferencedSpindle | Sets an unreferenced spindle of the channel |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
GeometryAxisX¶
-
KinematicChannelBuilder.GeometryAxisX¶ Returns or sets the geometry X axis of the channel
-------------------------------------Getter Method
Signature
GeometryAxisXReturns: the x axis Return type: str New in version NX9.0.3.
License requirements: None.
-------------------------------------Setter Method
Signature
GeometryAxisXParameters: xAxis (str) – the x axis New in version NX9.0.3.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
GeometryAxisY¶
-
KinematicChannelBuilder.GeometryAxisY¶ Returns or sets the geometry Y axis of the channel
-------------------------------------Getter Method
Signature
GeometryAxisYReturns: the y axis Return type: str New in version NX9.0.3.
License requirements: None.
-------------------------------------Setter Method
Signature
GeometryAxisYParameters: yAxis (str) – the y axis New in version NX9.0.3.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
GeometryAxisZ¶
-
KinematicChannelBuilder.GeometryAxisZ¶ Returns or sets the geometry Z axis of the channel
-------------------------------------Getter Method
Signature
GeometryAxisZReturns: the z axis Return type: str New in version NX9.0.3.
License requirements: None.
-------------------------------------Setter Method
Signature
GeometryAxisZParameters: zAxis (str) – the z axis New in version NX9.0.3.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
MainSpindle¶
-
KinematicChannelBuilder.MainSpindle¶ Returns or sets the main spindle of the channel
-------------------------------------Getter Method
Signature
MainSpindleReturns: the main spindle Return type: str New in version NX9.0.3.
License requirements: None.
-------------------------------------Setter Method
Signature
MainSpindleParameters: mainSpindle (str) – the main spindle New in version NX9.0.3.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
Name¶
-
KinematicChannelBuilder.Name¶ Returns or sets the name of the channel
-------------------------------------Getter Method
Signature
NameReturns: The channel’s name Return type: str New in version NX9.0.3.
License requirements: None.
-------------------------------------Setter Method
Signature
NameParameters: name (str) – the channel’s new name New in version NX9.0.3.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
Method Detail¶
GetAssignedAxes¶
-
KinematicChannelBuilder.GetAssignedAxes¶ Gets a list of assigned axes of the channel
Signature
GetAssignedAxes()Returns: the list of assigned axes Return type: list of str New in version NX9.0.3.
License requirements: None.
GetReferencedSpindles¶
-
KinematicChannelBuilder.GetReferencedSpindles¶ Gets a list of referenced spindles of the channel
Signature
GetReferencedSpindles()Returns: the list of referenced spindles Return type: list of str New in version NX9.0.3.
License requirements: None.
SetAssignedAxes¶
-
KinematicChannelBuilder.SetAssignedAxes¶ Sets a list of assigned axes of the channel
Signature
SetAssignedAxes(assignedAxes)Parameters: assignedAxes (list of str) – the list of assigned axes New in version NX9.0.3.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
SetAssignedAxis¶
-
KinematicChannelBuilder.SetAssignedAxis¶ Sets an assigned axis of the channel
Signature
SetAssignedAxis(axisName)Parameters: axisName (str) – the assigned axis New in version NX9.0.3.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
SetReferencedSpindle¶
-
KinematicChannelBuilder.SetReferencedSpindle¶ Sets a referenced spindle of the channel
Signature
SetReferencedSpindle(spindleName)Parameters: spindleName (str) – the referenced spindle New in version NX9.0.3.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
SetReferencedSpindles¶
-
KinematicChannelBuilder.SetReferencedSpindles¶ Sets a list of referenced spindles of the channel
Signature
SetReferencedSpindles(refSpindles)Parameters: refSpindles (list of str) – the list of referenced spindles New in version NX9.0.3.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
SetUnassignedAxis¶
-
KinematicChannelBuilder.SetUnassignedAxis¶ Sets an unassigned axis of the channel
Signature
SetUnassignedAxis(axisName)Parameters: axisName (str) – the unassigned axis New in version NX9.0.3.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
SetUnreferencedSpindle¶
-
KinematicChannelBuilder.SetUnreferencedSpindle¶ Sets an unreferenced spindle of the channel
Signature
SetUnreferencedSpindle(spindleName)Parameters: spindleName (str) – the unreferenced spindle New in version NX9.0.3.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
Validate¶
-
KinematicChannelBuilder.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.