ScalarForceBuilder Class

class NXOpen.Motion.ScalarForceBuilder

Bases: NXOpen.Motion.MotionBuilder

Represents a NXOpen.Motion.ScalarForceBuilder

To create a new instance of this class, use NXOpen.Motion.ScalarForceCollection.CreateScalarForceBuilder()

New in version NX6.0.0.

Properties

Property Description
ActionCsys Returns or sets the action csys
ActionLink Returns the action link
ActionPoint Returns or sets the action point
Applicationtype Returns or sets the application type
Direction Returns or sets the 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
Name Returns or sets the name
Profile Returns the profile
ReactionCsys Returns or sets the reaction csys
ReactionLink Returns the reaction link
ReactionPoint Returns or sets the reaction point
Tag Returns the Tag for this object.
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

ScalarForceBuilder.ActionCsys

Returns or sets the action csys

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

Getter Method

Signature ActionCsys

Returns:
Return type:NXOpen.CoordinateSystem

New in version NX12.0.0.

License requirements: None.

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

Setter Method

Signature ActionCsys

Parameters:actionCsys (NXOpen.CoordinateSystem) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

ActionPoint

ScalarForceBuilder.ActionPoint

Returns or sets the action point

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

Getter Method

Signature ActionPoint

Returns:
Return type:NXOpen.Point

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature ActionPoint

Parameters:actionPoint (NXOpen.Point) –

New in version NX6.0.0.

License requirements: mechanisms (“MECHANISMS”)

Applicationtype

ScalarForceBuilder.Applicationtype

Returns or sets the application type

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

Getter Method

Signature Applicationtype

Returns:
Return type:NXOpen.Motion.ScalarForceBuilderApplicationType

New in version NX12.0.0.

License requirements: None.

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

Setter Method

Signature Applicationtype

Parameters:type (NXOpen.Motion.ScalarForceBuilderApplicationType) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

Direction

ScalarForceBuilder.Direction

Returns or sets the direction

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

Getter Method

Signature Direction

Returns:
Return type:NXOpen.Motion.ScalarForceBuilderDirectionType

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

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

Setter Method

Signature Direction

Parameters:type (NXOpen.Motion.ScalarForceBuilderDirectionType) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

Function

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

Name

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

ScalarForceBuilder.Profile

Returns the profile

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

Getter Method

Signature Profile

Returns:
Return type:NXOpen.Motion.SelectFieldData

New in version NX12.0.0.

License requirements: None.

ReactionCsys

ScalarForceBuilder.ReactionCsys

Returns or sets the reaction csys

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

Getter Method

Signature ReactionCsys

Returns:
Return type:NXOpen.CoordinateSystem

New in version NX12.0.0.

License requirements: None.

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

Setter Method

Signature ReactionCsys

Parameters:reactionCsys (NXOpen.CoordinateSystem) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

ReactionPoint

ScalarForceBuilder.ReactionPoint

Returns or sets the reaction point

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

Getter Method

Signature ReactionPoint

Returns:
Return type:NXOpen.Point

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature ReactionPoint

Parameters:reactionPoint (NXOpen.Point) –

New in version NX6.0.0.

License requirements: mechanisms (“MECHANISMS”)

ValueExpression

ScalarForceBuilder.ValueExpression

Returns the value expression

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

Getter Method

Signature ValueExpression

Returns:
Return type:NXOpen.Expression

New in version NX8.0.0.

License requirements: None.

ValueType

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

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