ScalarTorqueBuilder Class

class NXOpen.Motion.ScalarTorqueBuilder

Bases: NXOpen.Motion.MotionBuilder

Represents a NXOpen.Motion.ScalarTorqueBuilder

To create a new instance of this class, use NXOpen.Motion.ScalarTorqueCollection.CreateScalarTorqueBuilder()

New in version NX6.0.0.

Properties

Property Description
ActionCsys Returns or sets the action csys
ActionLink Returns the action link attachment.
ActionPoint Returns or sets the action point
ApplicationType Returns or sets the scalar torque application type.
BaseCsys Returns or sets the base csys
BaseLink Returns the base link attachment.
BasePoint Returns or sets the base point
Direction Returns or sets the control Output Variable direction.
DisplayScale Returns or sets the icon display scale
Function Returns or sets the function
GroupName Returns or sets the group name
GroupType Returns or sets the group type
Joint Returns the joint
Name Returns or sets the name
Profile Returns the profile
Tag Returns the Tag for this object.
TorqueType Returns or sets the type.
ValueExpression Returns the value expression
ValueType Returns or sets the value 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.

Property Detail

ActionCsys

ScalarTorqueBuilder.ActionCsys

Returns or sets the action csys

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

Getter Method

Signature ActionCsys

Returns:
Return type:NXOpen.CoordinateSystem

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature ActionCsys

Parameters:actionCsysTag (NXOpen.CoordinateSystem) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

ActionPoint

ScalarTorqueBuilder.ActionPoint

Returns or sets the action point

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

Getter Method

Signature ActionPoint

Returns:
Return type:NXOpen.Point

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature ActionPoint

Parameters:actionPointTag (NXOpen.Point) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

ApplicationType

ScalarTorqueBuilder.ApplicationType

Returns or sets the scalar torque application type.

Default Type is Action-Reaction.

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

Getter Method

Signature ApplicationType

Returns:
Return type:NXOpen.Motion.ScalarTorqueBuilderAppType

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature ApplicationType

Parameters:appType (NXOpen.Motion.ScalarTorqueBuilderAppType) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

BaseCsys

ScalarTorqueBuilder.BaseCsys

Returns or sets the base csys

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

Getter Method

Signature BaseCsys

Returns:
Return type:NXOpen.CoordinateSystem

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature BaseCsys

Parameters:baseCsysTag (NXOpen.CoordinateSystem) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

BasePoint

ScalarTorqueBuilder.BasePoint

Returns or sets the base point

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

Getter Method

Signature BasePoint

Returns:
Return type:NXOpen.Point

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature BasePoint

Parameters:basePointTag (NXOpen.Point) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

Direction

ScalarTorqueBuilder.Direction

Returns or sets the control Output Variable direction.

Default Control Output Variable Direction is Z direction.

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

Getter Method

Signature Direction

Returns:
Return type:NXOpen.Motion.ScalarTorqueBuilderDirectionType

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature Direction

Parameters:direction (NXOpen.Motion.ScalarTorqueBuilderDirectionType) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

Function

ScalarTorqueBuilder.Function

Returns or sets the function

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

Getter Method

Signature Function

Returns:
Return type:NXOpen.CAE.Function

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature Function

Parameters:function (NXOpen.CAE.Function) –

New in version NX6.0.0.

License requirements: mechanisms (“MECHANISMS”)

Joint

ScalarTorqueBuilder.Joint

Returns the joint

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

Getter Method

Signature Joint

Returns:
Return type:NXOpen.Motion.SelectJoint

New in version NX6.0.0.

License requirements: None.

Name

ScalarTorqueBuilder.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”)

Profile

ScalarTorqueBuilder.Profile

Returns the profile

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

Getter Method

Signature Profile

Returns:
Return type:NXOpen.Motion.SelectFieldData

New in version NX12.0.0.

License requirements: None.

TorqueType

ScalarTorqueBuilder.TorqueType

Returns or sets the type.

Default type is Link.

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

Getter Method

Signature TorqueType

Returns:
Return type:NXOpen.Motion.ScalarTorqueBuilderScalarTorqueType

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature TorqueType

Parameters:torqueType (NXOpen.Motion.ScalarTorqueBuilderScalarTorqueType) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

ValueExpression

ScalarTorqueBuilder.ValueExpression

Returns the value expression

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

Getter Method

Signature ValueExpression

Returns:
Return type:NXOpen.Expression

New in version NX8.0.0.

License requirements: None.

ValueType

ScalarTorqueBuilder.ValueType

Returns or sets the value type

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

Getter Method

Signature ValueType

Returns:
Return type:NXOpen.Motion.ForceValueTypes

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature ValueType

Parameters:valueType (NXOpen.Motion.ForceValueTypes) –

New in version NX6.0.0.

License requirements: mechanisms (“MECHANISMS”)

Method Detail

Validate

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