ScalarForceBuilder Class¶
-
class
NXOpen.Motion.ScalarForceBuilder¶ Bases:
NXOpen.Motion.MotionBuilderRepresents a
NXOpen.Motion.ScalarForceBuilderTo create a new instance of this class, use
NXOpen.Motion.ScalarForceCollection.CreateScalarForceBuilder()New in version NX6.0.0.
Properties¶
| Property | Description |
|---|---|
| ActionLink | Returns the action link |
| ActionPoint | Returns or sets the action point |
| ConstantValue | Returns or sets the constant value |
| 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 |
| 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¶
ActionLink¶
-
ScalarForceBuilder.ActionLink¶ Returns the action link
-------------------------------------Getter Method
Signature
ActionLink()Returns: Return type: NXOpen.Motion.SelectLinkNew in version NX6.0.0.
License requirements: None.
ActionPoint¶
-
ScalarForceBuilder.ActionPoint¶ Returns or sets the action point
-------------------------------------Getter Method
Signature
ActionPoint()Returns: Return type: NXOpen.PointNew in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ActionPoint(actionPoint)Parameters: actionPoint ( NXOpen.Point) –New in version NX6.0.0.
License requirements: mechanisms (“MECHANISMS”)
ConstantValue¶
-
ScalarForceBuilder.ConstantValue¶ Returns or sets the constant value
-------------------------------------Getter Method
Signature
ConstantValue()Returns: Return type: float New in version NX6.0.0.
Deprecated since version NX8.0.0: Obtain the expression using
NXOpen.Motion.ScalarForceBuilder.ValueExpression()to query or edit it.License requirements: None.
-------------------------------------Setter Method
Signature
ConstantValue(constantValue)Parameters: constantValue (float) – New in version NX6.0.0.
Deprecated since version NX8.0.0: Obtain the expression using
NXOpen.Motion.ScalarForceBuilder.ValueExpression()to query or edit it.License requirements: mechanisms (“MECHANISMS”)
Function¶
-
ScalarForceBuilder.Function¶ Returns or sets the function
-------------------------------------Getter Method
Signature
Function()Returns: Return type: NXOpen.CAE.FunctionNew in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Function(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(name)Parameters: name (str) – New in version NX6.0.0.
License requirements: mechanisms (“MECHANISMS”)
ReactionLink¶
-
ScalarForceBuilder.ReactionLink¶ Returns the reaction link
-------------------------------------Getter Method
Signature
ReactionLink()Returns: Return type: NXOpen.Motion.SelectLinkNew in version NX6.0.0.
License requirements: None.
ReactionPoint¶
-
ScalarForceBuilder.ReactionPoint¶ Returns or sets the reaction point
-------------------------------------Getter Method
Signature
ReactionPoint()Returns: Return type: NXOpen.PointNew in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ReactionPoint(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.ExpressionNew 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.ForceValueTypesNew in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ValueType(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.