SpeedControlBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# SpeedControlBuilder Class

class `NXOpen.Mechatronics.``SpeedControlBuilder`

  Bases: `NXOpen.Mechatronics.PhysicsConstraintBuilder`

  Represents a `NXOpen.Mechatronics.SpeedControl` builder.

  To create a new instance of this class, use `NXOpen.Mechatronics.SpeedControlCollection.CreateSpeedControlBuilder()`

  New in version NX7.5.1.

# Properties

Property | Description
--- | ---
AxisJoint | Returns the joint select.
AxisType | Returns or sets the axis joint type.
DirectionType | Returns or sets the direction type, which works only when the speed control is used to drive `NXOpen.Mechatronics.TransportSurface`
EnableLimitForce | Returns or sets whether or not to enable the limit force.
ForwardForce | Returns the forward force that speed control can apply.
LimitJerk | Returns or sets the limit jerk flag, which is used to control if the speed control includes jerk data.
MaxAcceleration | Returns the max acceleration, which is used to set the maximum acceleration for speed control.
MaxJerk | Returns the max jerk, which is used to set the maximum jerk for speed control.
Name | Returns or sets the name.
ReverseForce | Returns the min force that speed control can apply.
Signal | Returns the signal select.
Speed | Returns the speed.
Tag | Returns the Tag for this object.
UseAcceleration | Returns or sets the use acceleration flag, which is used to control if the speed control includes acceleration data.

# 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.
SetAxisJoint | Sets the joint.
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

SpeedControlBuilderAxisJointType Enumeration | the Axis Joint types.

# Property Detail

## AxisJoint

`SpeedControlBuilder.``AxisJoint`

  Returns the joint select.

  This can be a `NXOpen.Mechatronics.HingeJoint`, `NXOpen.Mechatronics.SlidingJoint` , `NXOpen.Mechatronics.CylindricalJoint` and `NXOpen.Mechatronics.TransportSurface`.

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

  Getter Method

  Signature `AxisJoint`

  Returns: |
  Return type: | `NXOpen.Mechatronics.SelectPhysicsJoint`

  New in version NX7.5.1.

  License requirements: None.

## AxisType

`SpeedControlBuilder.``AxisType`

  Returns or sets the axis joint type.

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

  Getter Method

  Signature `AxisType`

  Returns: |
  Return type: | `NXOpen.Mechatronics.SpeedControlBuilderAxisJointType`

  New in version NX7.5.1.

  License requirements: None.

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

  Setter Method

  Signature `AxisType`

  Parameters: | axisType (`NXOpen.Mechatronics.SpeedControlBuilderAxisJointType`) –

  New in version NX7.5.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## DirectionType

`SpeedControlBuilder.``DirectionType`

  Returns or sets the direction type, which works only when the speed control is used to drive `NXOpen.Mechatronics.TransportSurface`

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

  Getter Method

  Signature `DirectionType`

  Returns: |
  Return type: | `NXOpen.Mechatronics.SpeedPositionControlDirectiontype`

  New in version NX10.0.0.

  License requirements: None.

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

  Setter Method

  Signature `DirectionType`

  Parameters: | directionType (`NXOpen.Mechatronics.SpeedPositionControlDirectiontype`) –

  New in version NX10.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## EnableLimitForce

`SpeedControlBuilder.``EnableLimitForce`

  Returns or sets whether or not to enable the limit force.

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

  Getter Method

  Signature `EnableLimitForce`

  Returns: |
  Return type: | bool

  New in version NX9.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

  Setter Method

  Signature `EnableLimitForce`

  Parameters: | enable (bool) –

  New in version NX9.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## ForwardForce

`SpeedControlBuilder.``ForwardForce`

  Returns the forward force that speed control can apply.

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

  Getter Method

  Signature `ForwardForce`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX9.0.0.

  License requirements: None.

## LimitJerk

`SpeedControlBuilder.``LimitJerk`

  Returns or sets the limit jerk flag, which is used to control if the speed control includes jerk data.

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

  Getter Method

  Signature `LimitJerk`

  Returns: |
  Return type: | bool

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `LimitJerk`

  Parameters: | limitJerk (bool) –

  New in version NX9.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## MaxAcceleration

`SpeedControlBuilder.``MaxAcceleration`

  Returns the max acceleration, which is used to set the maximum acceleration for speed control.

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

  Getter Method

  Signature `MaxAcceleration`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX9.0.0.

  License requirements: None.

## MaxJerk

`SpeedControlBuilder.``MaxJerk`

  Returns the max jerk, which is used to set the maximum jerk for speed control.

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

  Getter Method

  Signature `MaxJerk`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX9.0.0.

  License requirements: None.

## ReverseForce

`SpeedControlBuilder.``ReverseForce`

  Returns the min force that speed control can apply.

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

  Getter Method

  Signature `ReverseForce`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX9.0.0.

  License requirements: None.

## Signal

`SpeedControlBuilder.``Signal`

  Returns the signal select.

  This can be a `NXOpen.Mechatronics.Signal` or `NXOpen.Mechatronics.AdapterSignal`.

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

  Getter Method

  Signature `Signal`

  Returns: |
  Return type: | `NXOpen.SelectNXObject`

  New in version NX12.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## Speed

`SpeedControlBuilder.``Speed`

  Returns the speed.

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

  Getter Method

  Signature `Speed`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX7.5.1.

  License requirements: None.

## UseAcceleration

`SpeedControlBuilder.``UseAcceleration`

  Returns or sets the use acceleration flag, which is used to control if the speed control includes acceleration data.

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

  Getter Method

  Signature `UseAcceleration`

  Returns: |
  Return type: | bool

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `UseAcceleration`

  Parameters: | useAcceleration (bool) –

  New in version NX9.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

# Method Detail

## SetAxisJoint

`SpeedControlBuilder.``SetAxisJoint`

  Sets the joint.

  Signature `SetAxisJoint(axisJoint)`

  Parameters: | axisJoint (`NXOpen.NXObject`) –

  New in version NX7.5.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## Validate

`SpeedControlBuilder.``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.