PositionControlBuilder Class

class NXOpen.Mechatronics.PositionControlBuilder

Bases: NXOpen.Mechatronics.PhysicsConstraintBuilder

Represents a NXOpen.Mechatronics.PositionControlBuilder.

To create a new instance of this class, use NXOpen.Mechatronics.PositionControlCollection.CreatePositionControlBuilder()

New in version NX7.5.1.

Properties

Property Description
AngularPath Returns or sets the angular path.
AxisJoint Returns the joint select.
AxisType Returns or sets the axis type.
Destination Returns the destination.
DirectionType Returns or sets the direction type, which works only when the position control is used to drive NXOpen.Mechatronics.TransportSurface
EnableLimitForce Returns or sets whether or not to enable the limit force.
ForwardForce Returns the max force that speed control can apply.
LimitJerk Returns or sets the limit jerk flag, which is used to control if the position control includes jerk data.
MaxAcceleration Returns the max acceleration, which is used to set the maximum acceleration for position control.
MaxDeceleration Returns the max deceleration, which is used to set the maximum deceleration for position control.
MaxJerk Returns the max jerk, which is used to set the maximum jerk for position 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 position 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.

Property Detail

AngularPath

PositionControlBuilder.AngularPath

Returns or sets the angular path.

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

Getter Method

Signature AngularPath

Returns:
Return type:NXOpen.Mechatronics.PositionControlBuilderAngularPathOptions

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature AngularPath

Parameters:angularPath (NXOpen.Mechatronics.PositionControlBuilderAngularPathOptions) –

New in version NX8.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

AxisJoint

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

PositionControlBuilder.AxisType

Returns or sets the axis type.

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

Getter Method

Signature AxisType

Returns:
Return type:NXOpen.Mechatronics.PositionControlBuilderAxis

New in version NX7.5.1.

License requirements: None.

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

Setter Method

Signature AxisType

Parameters:axisType (NXOpen.Mechatronics.PositionControlBuilderAxis) –

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Destination

PositionControlBuilder.Destination

Returns the destination.

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

Getter Method

Signature Destination

Returns:
Return type:NXOpen.Expression

New in version NX7.5.1.

License requirements: None.

DirectionType

PositionControlBuilder.DirectionType

Returns or sets the direction type, which works only when the position 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: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature DirectionType

Parameters:directionType (NXOpen.Mechatronics.SpeedPositionControlDirectiontype) –

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

EnableLimitForce

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

PositionControlBuilder.ForwardForce

Returns the max 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

PositionControlBuilder.LimitJerk

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

PositionControlBuilder.MaxAcceleration

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

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

Getter Method

Signature MaxAcceleration

Returns:
Return type:NXOpen.Expression

New in version NX9.0.0.

License requirements: None.

MaxDeceleration

PositionControlBuilder.MaxDeceleration

Returns the max deceleration, which is used to set the maximum deceleration for position control.

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

Getter Method

Signature MaxDeceleration

Returns:
Return type:NXOpen.Expression

New in version NX9.0.0.

License requirements: None.

MaxJerk

PositionControlBuilder.MaxJerk

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

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

Getter Method

Signature MaxJerk

Returns:
Return type:NXOpen.Expression

New in version NX9.0.0.

License requirements: None.

ReverseForce

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

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

PositionControlBuilder.Speed

Returns the speed.

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

Getter Method

Signature Speed

Returns:
Return type:NXOpen.Expression

New in version NX7.5.1.

License requirements: None.

UseAcceleration

PositionControlBuilder.UseAcceleration

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

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

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