MotionSensorBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# MotionSensorBuilder Class

class `NXOpen.Motion.``MotionSensorBuilder`

  Bases: `NXOpen.Motion.MotionBuilder`

  Represents a `NXOpen.Motion.MotionSensorBuilder`

  To create a new instance of this class, use `NXOpen.Motion.MotionSensorCollection.CreateMotionSensorBuilder()`

  Default values.

  Property | Value
  --- | ---
  ComponentType | LinearMagnitude
  ReferenceFrame | Absolute
  Type | Displacement

  New in version NX6.0.0.

# Properties

Property | Description
--- | ---
ComponentType | Returns or sets the component type
DisplayScale | Returns or sets the icon display scale
GroupName | Returns or sets the group name
GroupType | Returns or sets the group type
MeasurementObject | Returns the first marker object
Name | Returns or sets the name
ReferenceFrame | Returns or sets the reference frame type
ReferenceMarker | Returns the reference marker object
RelativeMarker | Returns the second marker object
Tag | Returns the Tag for this object.
Type | Returns or sets the sensor type

# 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

MotionSensorBuilderComponent Enumeration | component enumeration type
MotionSensorBuilderReference Enumeration | reference frame enumeration type
MotionSensorBuilderTypes Enumeration | sensor type

# Property Detail

## ComponentType

`MotionSensorBuilder.``ComponentType`

  Returns or sets the component type

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

  Getter Method

  Signature `ComponentType`

  Returns: |
  Return type: | `NXOpen.Motion.MotionSensorBuilderComponent`

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ComponentType`

  Parameters: | componentType (`NXOpen.Motion.MotionSensorBuilderComponent`) –

  New in version NX6.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## MeasurementObject

`MotionSensorBuilder.``MeasurementObject`

  Returns the first marker object

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

  Getter Method

  Signature `MeasurementObject`

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

  New in version NX6.0.0.

  License requirements: None.

## Name

`MotionSensorBuilder.``Name`

  Returns or sets the name

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

  Getter Method

  Signature `Name`

  Returns: |
  Return type: | str

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Name`

  Parameters: | name (str) –

  New in version NX6.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## ReferenceFrame

`MotionSensorBuilder.``ReferenceFrame`

  Returns or sets the reference frame type

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

  Getter Method

  Signature `ReferenceFrame`

  Returns: |
  Return type: | `NXOpen.Motion.MotionSensorBuilderReference`

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ReferenceFrame`

  Parameters: | referenceFrame (`NXOpen.Motion.MotionSensorBuilderReference`) –

  New in version NX6.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## ReferenceMarker

`MotionSensorBuilder.``ReferenceMarker`

  Returns the reference marker object

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

  Getter Method

  Signature `ReferenceMarker`

  Returns: |
  Return type: | `NXOpen.Motion.SelectMarker`

  New in version NX6.0.0.

  License requirements: None.

## RelativeMarker

`MotionSensorBuilder.``RelativeMarker`

  Returns the second marker object

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

  Getter Method

  Signature `RelativeMarker`

  Returns: |
  Return type: | `NXOpen.Motion.SelectMarker`

  New in version NX6.0.0.

  License requirements: None.

## Type

`MotionSensorBuilder.``Type`

  Returns or sets the sensor type

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

  Getter Method

  Signature `Type`

  Returns: |
  Return type: | `NXOpen.Motion.MotionSensorBuilderTypes`

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Type`

  Parameters: | type (`NXOpen.Motion.MotionSensorBuilderTypes`) –

  New in version NX6.0.0.

  License requirements: mechanisms (“MECHANISMS”)

# Method Detail

## Validate

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