KinematicAxisBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# KinematicAxisBuilder Class

class `NXOpen.SIM.``KinematicAxisBuilder`

  Bases: `NXOpen.Builder`

  Represents the SimKimAxisBuilder class object

  Use the `NXOpen.SIM.KinematicConfigurator` class to create a KinematicAxisBuilder object.

  New in version NX7.5.0.

# Properties

Property | Description
--- | ---
CoarsePrecision | Returns or sets the coarse precision.
Direction | Returns or sets the axis direction
FinePrecision | Returns or sets the fine precision.
InitialValue | Returns or sets the initial value
JerkLimit | Returns or sets the jerk limit.
JumpVelocity | Returns or sets the jump velocity.
Junction | Returns or sets the junction
Kv | Returns or sets the kv.
Limit | Returns or sets the axis limits flag
LowerLimit | Returns or sets the lower limit
LowerSoftLimit | Returns or sets the lower soft limit.
MaxAcceleration | Returns or sets the max acceleration.
MaxDeceleration | Returns or sets the max deceleration.
MaximumVelocity | Returns or sets the maximum velocity
Name | Returns or sets the kinematic axis’s name
Number | Returns or sets the kinematic axis’s number.
Tag | Returns the Tag for this object.
Type | Returns or sets the axis motion
UpperLimit | Returns or sets the upper limit
UpperSoftLimit | Returns or sets the upper soft 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

## CoarsePrecision

`KinematicAxisBuilder.``CoarsePrecision`

  Returns or sets the coarse precision.

  This defines the exact stop precision used to determine if a target point has been reached, so that the next NC-block can be executed.

  `-------------------------------------`

  Getter Method

  Signature `CoarsePrecision`

  Returns: | the Coarse Precision
  Return type: | float

  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”)

  `-------------------------------------`

  Setter Method

  Signature `CoarsePrecision`

  Parameters: | coarse (float) – the Coarse Precision

  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”)

## Direction

`KinematicAxisBuilder.``Direction`

  Returns or sets the axis direction

  `-------------------------------------`

  Getter Method

  Signature `Direction`

  Returns: | the axis direction
  Return type: | `NXOpen.SIM.KinematicAxisBuilderAxisDirectionType`

  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 `Direction`

  Parameters: | axisDir (`NXOpen.SIM.KinematicAxisBuilderAxisDirectionType`) – the axis direction

  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”)

## FinePrecision

`KinematicAxisBuilder.``FinePrecision`

  Returns or sets the fine precision.

  This defines the exact stop precision used to determine if a target point has been reached, so that the next NC-block can be executed.

  `-------------------------------------`

  Getter Method

  Signature `FinePrecision`

  Returns: | the Fine Precision
  Return type: | float

  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”)

  `-------------------------------------`

  Setter Method

  Signature `FinePrecision`

  Parameters: | fine (float) – the Fine Precision

  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”)

## 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`

  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”)

## JerkLimit

`KinematicAxisBuilder.``JerkLimit`

  Returns or sets the jerk limit.

  The jerk limit value limits jumps in acceleration.

  `-------------------------------------`

  Getter Method

  Signature `JerkLimit`

  Returns: | the jerk limit
  Return type: | float

  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”)

  `-------------------------------------`

  Setter Method

  Signature `JerkLimit`

  Parameters: | jerk (float) – the jerk limit

  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”)

## JumpVelocity

`KinematicAxisBuilder.``JumpVelocity`

  Returns or sets the jump velocity.

  The jump velocity define a lag time at the beginning of the motion.

  `-------------------------------------`

  Getter Method

  Signature `JumpVelocity`

  Returns: | the jerk limit
  Return type: | float

  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”)

  `-------------------------------------`

  Setter Method

  Signature `JumpVelocity`

  Parameters: | jump (float) – the Jump Velocity

  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”)

## Junction

`KinematicAxisBuilder.``Junction`

  Returns or sets the junction

  `-------------------------------------`

  Getter Method

  Signature `Junction`

  Returns: | the junction
  Return type: | `NXOpen.SIM.KinematicJunction`

  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 `Junction`

  Parameters: | jct (`NXOpen.SIM.KinematicJunction`) – the junction

  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”)

## Kv

`KinematicAxisBuilder.``Kv`

  Returns or sets the kv.

  the Kv-Factor is a parameter of the drives. It influences the dragging error (difference between ideal motion profile and actual motion profile).

  `-------------------------------------`

  Getter Method

  Signature `Kv`

  Returns: | the Kv
  Return type: | float

  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”)

  `-------------------------------------`

  Setter Method

  Signature `Kv`

  Parameters: | kv (float) – the Kv

  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”)

## Limit

`KinematicAxisBuilder.``Limit`

  Returns or sets the axis limits flag

  This property is deprecated. Use `SIM.KinematicAxisBuilderAxisMotionType` instead.

  `-------------------------------------`

  Getter Method

  Signature `Limit`

  Returns: | the axis limits flag
  Return type: | bool

  New in version NX7.5.0.

  Deprecated since version NX9.0.3: Use `SIM.KinematicAxisBuilderAxisMotionType` instead.

  License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

  `-------------------------------------`

  Setter Method

  Signature `Limit`

  Parameters: | onOff (bool) – the axis limits flag

  New in version NX7.5.0.

  Deprecated since version NX9.0.3: Use `SIM.KinematicAxisBuilderAxisMotionType` instead.

  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`

  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”)

## LowerSoftLimit

`KinematicAxisBuilder.``LowerSoftLimit`

  Returns or sets the lower soft limit.

  The soft limit on the real machine is checked by the controller to avoid that the machine travels into the mechanical stop (Hard Limit) with full speed (prevent damage)

  `-------------------------------------`

  Getter Method

  Signature `LowerSoftLimit`

  Returns: | the lower soft limit
  Return type: | float

  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”)

  `-------------------------------------`

  Setter Method

  Signature `LowerSoftLimit`

  Parameters: | lower (float) – the lower soft limit

  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”)

## MaxAcceleration

`KinematicAxisBuilder.``MaxAcceleration`

  Returns or sets the max acceleration.

  The maximum acceleration defines how fast the axis can accelerate.

  `-------------------------------------`

  Getter Method

  Signature `MaxAcceleration`

  Returns: | the Max Acceleration
  Return type: | float

  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”)

  `-------------------------------------`

  Setter Method

  Signature `MaxAcceleration`

  Parameters: | max (float) – the Max Acceleration

  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”)

## MaxDeceleration

`KinematicAxisBuilder.``MaxDeceleration`

  Returns or sets the max deceleration.

  The maximum deceleration defines how fast the axis can decelerate.

  `-------------------------------------`

  Getter Method

  Signature `MaxDeceleration`

  Returns: | the Max Deceleration
  Return type: | float

  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”)

  `-------------------------------------`

  Setter Method

  Signature `MaxDeceleration`

  Parameters: | max (float) – the Max Deceleration

  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”)

## 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`

  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`

  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”)

## Number

`KinematicAxisBuilder.``Number`

  Returns or sets the kinematic axis’s number.

  The axis number is used in cases where an axis is programmed through a number instead of through an address (e.g. on Siemens 840D: AX1=10 instead of X10).

  `-------------------------------------`

  Getter Method

  Signature `Number`

  Returns: | The axis’s number
  Return type: | int

  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”)

  `-------------------------------------`

  Setter Method

  Signature `Number`

  Parameters: | number (int) – the axis’s new number

  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”)

## Type

`KinematicAxisBuilder.``Type`

  Returns or sets the axis motion

  `-------------------------------------`

  Getter Method

  Signature `Type`

  Returns: | the axis type
  Return type: | `NXOpen.SIM.KinematicAxisBuilderAxisMotionType`

  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 `Type`

  Parameters: | type (`NXOpen.SIM.KinematicAxisBuilderAxisMotionType`) – the axis type

  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”)

## 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`

  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”)

## UpperSoftLimit

`KinematicAxisBuilder.``UpperSoftLimit`

  Returns or sets the upper soft limit.

  The soft limit on the real machine is checked by the controller to avoid that the machine travels into the mechanical stop (Hard Limit) with full speed (prevent damage)

  `-------------------------------------`

  Getter Method

  Signature `UpperSoftLimit`

  Returns: | the upper soft limit
  Return type: | float

  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”)

  `-------------------------------------`

  Setter Method

  Signature `UpperSoftLimit`

  Parameters: | upper (float) – the upper soft limit

  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

## 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.