KinematicAxisBuilder Class¶
-
class
NXOpen.SIM.KinematicAxisBuilder¶ Bases:
NXOpen.BuilderRepresents the SimKimAxisBuilder class object
Use the
NXOpen.SIM.KinematicConfiguratorclass to create a KinematicAxisBuilder object.New in version NX7.5.0.
Properties¶
| Property | Description |
|---|---|
| Direction | Returns or sets the axis direction |
| InitialValue | Returns or sets the initial value |
| Junction | Returns or sets the junction |
| Limit | Returns or sets the axis limits flag |
| LowerLimit | Returns or sets the lower limit |
| MaximumVelocity | Returns or sets the maximum velocity |
| Name | Returns or sets the kinematic axis’s name |
| Tag | Returns the Tag for this object. |
| Type | Returns or sets the axis motion |
| UpperLimit | Returns or sets the upper limit |
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¶
| KinematicAxisBuilderAxisDirectionType Enumeration | The axis direction type |
| KinematicAxisBuilderAxisMotionType Enumeration | The axis motions type |
Property Detail¶
Direction¶
-
KinematicAxisBuilder.Direction¶ Returns or sets the axis direction
-------------------------------------Getter Method
Signature
Direction()Returns: the axis direction Return type: NXOpen.SIM.KinematicAxisBuilderAxisDirectionTypeNew in version NX7.5.0.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
-------------------------------------Setter Method
Signature
Direction(axisDir)Parameters: axisDir ( NXOpen.SIM.KinematicAxisBuilderAxisDirectionType) – the axis directionNew in version NX7.5.0.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
InitialValue¶
-
KinematicAxisBuilder.InitialValue¶ Returns or sets the initial value
-------------------------------------Getter Method
Signature
InitialValue()Returns: the initial value Return type: float New in version NX7.5.0.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
-------------------------------------Setter Method
Signature
InitialValue(initial)Parameters: initial (float) – the initial value New in version NX7.5.0.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
Junction¶
-
KinematicAxisBuilder.Junction¶ Returns or sets the junction
-------------------------------------Getter Method
Signature
Junction()Returns: the junction Return type: NXOpen.SIM.KinematicJunctionNew in version NX7.5.0.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
-------------------------------------Setter Method
Signature
Junction(jct)Parameters: jct ( NXOpen.SIM.KinematicJunction) – the junctionNew in version NX7.5.0.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
Limit¶
-
KinematicAxisBuilder.Limit¶ Returns or sets the axis limits flag
-------------------------------------Getter Method
Signature
Limit()Returns: the axis limits flag Return type: bool New in version NX7.5.0.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
-------------------------------------Setter Method
Signature
Limit(onOff)Parameters: onOff (bool) – the axis limits flag New in version NX7.5.0.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
LowerLimit¶
-
KinematicAxisBuilder.LowerLimit¶ Returns or sets the lower limit
-------------------------------------Getter Method
Signature
LowerLimit()Returns: the lower limit Return type: float New in version NX7.5.0.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
-------------------------------------Setter Method
Signature
LowerLimit(lower)Parameters: lower (float) – the lower limit New in version NX7.5.0.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
MaximumVelocity¶
-
KinematicAxisBuilder.MaximumVelocity¶ Returns or sets the maximum velocity
-------------------------------------Getter Method
Signature
MaximumVelocity()Returns: the maximum velocity Return type: float New in version NX7.5.0.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
-------------------------------------Setter Method
Signature
MaximumVelocity(velocity)Parameters: velocity (float) – the maximum velocity New in version NX7.5.0.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
Name¶
-
KinematicAxisBuilder.Name¶ Returns or sets the kinematic axis’s name
-------------------------------------Getter Method
Signature
Name()Returns: The axis’s name Return type: str New in version NX7.5.0.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
-------------------------------------Setter Method
Signature
Name(name)Parameters: name (str) – the axis’s new name New in version NX7.5.0.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
Type¶
-
KinematicAxisBuilder.Type¶ Returns or sets the axis motion
-------------------------------------Getter Method
Signature
Type()Returns: the axis type Return type: NXOpen.SIM.KinematicAxisBuilderAxisMotionTypeNew in version NX7.5.0.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
-------------------------------------Setter Method
Signature
Type(type)Parameters: type ( NXOpen.SIM.KinematicAxisBuilderAxisMotionType) – the axis typeNew in version NX7.5.0.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
UpperLimit¶
-
KinematicAxisBuilder.UpperLimit¶ Returns or sets the upper limit
-------------------------------------Getter Method
Signature
UpperLimit()Returns: the upper limit Return type: float New in version NX7.5.0.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
-------------------------------------Setter Method
Signature
UpperLimit(upper)Parameters: upper (float) – the upper limit New in version NX7.5.0.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
Method Detail¶
Validate¶
-
KinematicAxisBuilder.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.