PositionSensorBuilder Class

class NXOpen.Mechatronics.PositionSensorBuilder

Bases: NXOpen.Mechatronics.PhysicsConstraintBuilder

Represents a NXOpen.Mechatronics.PositionSensor builder.

To create a new instance of this class, use NXOpen.Mechatronics.PositionSensorCollection.CreatePositionSensorBuilder()

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 and NXOpen.Mechatronics.PositionControl.
AxisType Returns or sets the axis type.
LowerOutputRange Returns the lower output range used to scale the position data. Its measure type contains constant, voltage, current
LowerTrimRange Returns the lower trim range used to trim the position 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 position data.
UpperTrimRange Returns the upper trim range used to trim the position data.
UseScale Returns or sets the use scale flag, which is used to control if the position sensor includes scale parameters.
UseTrim Returns or sets the use trim flag, which is used to control if the position 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.

Property Detail

AxisJoint

PositionSensorBuilder.AxisJoint

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

-------------------------------------

Getter Method

Signature AxisJoint

Returns:
Return type:NXOpen.SelectNXObject

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

AxisType

PositionSensorBuilder.AxisType

Returns or sets the axis type.

-------------------------------------

Getter Method

Signature AxisType

Returns:
Return type:NXOpen.Mechatronics.PositionSensorBuilderAxisJointType

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

-------------------------------------

Setter Method

Signature AxisType

Parameters:axisType (NXOpen.Mechatronics.PositionSensorBuilderAxisJointType) –

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

LowerOutputRange

PositionSensorBuilder.LowerOutputRange

Returns the lower output range used to scale the position 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

PositionSensorBuilder.LowerTrimRange

Returns the lower trim range used to trim the position 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

PositionSensorBuilder.MeasureType

Returns or sets the measure type.

-------------------------------------

Getter Method

Signature MeasureType

Returns:
Return type:NXOpen.Mechatronics.PositionSensorBuilderOutputMeasureType

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

-------------------------------------

Setter Method

Signature MeasureType

Parameters:measureType (NXOpen.Mechatronics.PositionSensorBuilderOutputMeasureType) –

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

UpperOutputRange

PositionSensorBuilder.UpperOutputRange

Returns the upper output range used to scale the position 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

PositionSensorBuilder.UpperTrimRange

Returns the upper trim range used to trim the position 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

PositionSensorBuilder.UseScale

Returns or sets the use scale flag, which is used to control if the position 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

PositionSensorBuilder.UseTrim

Returns or sets the use trim flag, which is used to control if the position 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

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