VelocitySensorBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# VelocitySensorBuilder Class

class `NXOpen.Mechatronics.``VelocitySensorBuilder`

  Bases: `NXOpen.Mechatronics.PhysicsConstraintBuilder`

  Represents a `NXOpen.Mechatronics.VelocitySensor` builder.

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

  New in version NX11.0.0.

# Properties

Property | Description
--- | ---
AxisJoint | Returns the joint select. This can be a `NXOpen.Mechatronics.HingeJoint`, `NXOpen.Mechatronics.SlidingJoint` , `NXOpen.Mechatronics.CylindricalJoint`, `NXOpen.Mechatronics.PointOnCurveJoint`, `NXOpen.Mechatronics.PositionControl` and `NXOpen.Mechatronics.SpeedControl`.
AxisType | Returns or sets the axis type.
LowerOutputRange | Returns the lower output range used to scale the velocity data. Its measure type contains constant, voltage, current
LowerTrimRange | Returns the lower trim range used to trim the velocity data.
MeasureType | Returns or sets the measure type.
Name | Returns or sets the name.
Tag | Returns the Tag for this object.
UpperOutputRange | Returns the upper output range used to scale the velocity data.
UpperTrimRange | Returns the upper trim range used to trim the velocity data.
UseScale | Returns or sets the use scale flag, which is used to control if the velocity sensor includes scale parameters.
UseTrim | Returns or sets the use trim flag, which is used to control if the velocity sensor includes trim parameters.

# 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

VelocitySensorBuilderAxisJointType Enumeration | the Axis Joint types.
VelocitySensorBuilderOutputMeasureType Enumeration | the Measure types.

# Property Detail

## AxisJoint

`VelocitySensorBuilder.``AxisJoint`

  Returns the joint select. This can be a `NXOpen.Mechatronics.HingeJoint`, `NXOpen.Mechatronics.SlidingJoint` , `NXOpen.Mechatronics.CylindricalJoint`, `NXOpen.Mechatronics.PointOnCurveJoint`, `NXOpen.Mechatronics.PositionControl` and `NXOpen.Mechatronics.SpeedControl`.

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

  Getter Method

  Signature `AxisJoint`

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

  New in version NX11.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## AxisType

`VelocitySensorBuilder.``AxisType`

  Returns or sets the axis type.

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

  Getter Method

  Signature `AxisType`

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

  New in version NX11.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

  Setter Method

  Signature `AxisType`

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

  New in version NX11.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## LowerOutputRange

`VelocitySensorBuilder.``LowerOutputRange`

  Returns the lower output range used to scale the velocity data. Its measure type contains constant, voltage, current

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

  Getter Method

  Signature `LowerOutputRange`

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

  New in version NX11.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## LowerTrimRange

`VelocitySensorBuilder.``LowerTrimRange`

  Returns the lower trim range used to trim the velocity data.

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

  Getter Method

  Signature `LowerTrimRange`

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

  New in version NX11.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## MeasureType

`VelocitySensorBuilder.``MeasureType`

  Returns or sets the measure type.

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

  Getter Method

  Signature `MeasureType`

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

  New in version NX11.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

  Setter Method

  Signature `MeasureType`

  Parameters: | measureType (`NXOpen.Mechatronics.VelocitySensorBuilderOutputMeasureType`) –

  New in version NX11.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## UpperOutputRange

`VelocitySensorBuilder.``UpperOutputRange`

  Returns the upper output range used to scale the velocity data.

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

  Getter Method

  Signature `UpperOutputRange`

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

  New in version NX11.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## UpperTrimRange

`VelocitySensorBuilder.``UpperTrimRange`

  Returns the upper trim range used to trim the velocity data.

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

  Getter Method

  Signature `UpperTrimRange`

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

  New in version NX11.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## UseScale

`VelocitySensorBuilder.``UseScale`

  Returns or sets the use scale flag, which is used to control if the velocity sensor includes scale parameters.

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

  Getter Method

  Signature `UseScale`

  Returns: |
  Return type: | bool

  New in version NX11.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

  Setter Method

  Signature `UseScale`

  Parameters: | useScale (bool) –

  New in version NX11.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## UseTrim

`VelocitySensorBuilder.``UseTrim`

  Returns or sets the use trim flag, which is used to control if the velocity sensor includes trim parameters.

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

  Getter Method

  Signature `UseTrim`

  Returns: |
  Return type: | bool

  New in version NX11.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

  Setter Method

  Signature `UseTrim`

  Parameters: | useTrim (bool) –

  New in version NX11.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

# Method Detail

## Validate

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