SpringBuilder Class¶
-
class
NXOpen.Motion.SpringBuilder¶ Bases:
NXOpen.Motion.ConnectorBuilderRepresents a SpringBuilder
To create a new instance of this class, use
NXOpen.Motion.SpringCollection.CreateSpringBuilder()Default values.
Property Value FreeLength (deprecated) 0.0 InitialLength (deprecated) 0.0 Stiffness (deprecated) 1.0 StiffnessType Constant New in version NX6.0.0.
Properties¶
| Property | Description |
|---|---|
| ActionLink | Returns the action link. |
| ActionPoint | Returns or sets the action point. |
| Attachment | Returns or sets the attachment type |
| CoefficientExpression | Returns the translational coefficient expression |
| CoefficientFunction | Returns or sets the function tag. |
| CoefficientType | Returns or sets the coefficient type |
| CreateDamper | Returns or sets the create damper toggle |
| DamperName | Returns or sets the damper dname |
| DisplayScale | Returns or sets the icon display scale |
| FreeAngleExpression | Returns the free angle expression |
| FreeLength | Returns or sets the free length |
| FreeLengthExpression | Returns the free length expression |
| GroupName | Returns or sets the group name |
| GroupType | Returns or sets the group type |
| InitialLength | Returns or sets the initial length used for spring attached to slide joint |
| InitialLengthExpression | Returns the initial length expression for spring which attachs to slide joint |
| Joint | Returns the joint . |
| LengthFlag | Returns or sets the length flag, if this flag is set to true, it will not update the preloaded length, if this flag is set to false, it will update the preloaded length according to the installed length |
| Name | Returns or sets the name |
| PreloadAngleExpression | Returns the preload expression |
| PreloadExpression | Returns the preload expression |
| PreloadForceExpression | Returns the preload force expression |
| PreloadMomentExpression | Returns the preload moment expression |
| PreloadedAngleExpression | Returns the preloaded angle expression |
| PreloadedLengthExpression | Returns the preloaded length expression |
| ReactionLink | Returns the reaction link. |
| ReactionPoint | Returns or sets the reaction point. |
| Stiffness | Returns or sets the stiffness. |
| StiffnessExpression | Returns the stiffness expression |
| StiffnessFunction | Returns or sets the function tag. |
| StiffnessType | Returns or sets the stiffness type |
| Tag | Returns the Tag for this object. |
| TorsionalCoefficientExpression | Returns the torsional coefficient expression |
| TorsionalStiffnessExpression | Returns the torsional stiffness expression |
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¶
CoefficientExpression¶
-
SpringBuilder.CoefficientExpression¶ Returns the translational coefficient expression
-------------------------------------Getter Method
Signature
CoefficientExpression()Returns: Return type: NXOpen.ExpressionNew in version NX8.5.0.
License requirements: None.
CoefficientFunction¶
-
SpringBuilder.CoefficientFunction¶ Returns or sets the function tag.
Only valid if
MotionConnectorCoefficientTypes.Splineis set-------------------------------------Getter Method
Signature
CoefficientFunction()Returns: Return type: NXOpen.CAE.FunctionNew in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CoefficientFunction(function)Parameters: function ( NXOpen.CAE.Function) –New in version NX8.5.0.
License requirements: mechanisms (“MECHANISMS”)
CoefficientType¶
-
SpringBuilder.CoefficientType¶ Returns or sets the coefficient type
-------------------------------------Getter Method
Signature
CoefficientType()Returns: Return type: NXOpen.Motion.ConnectorCoefficientTypesNew in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CoefficientType(coefficientType)Parameters: coefficientType ( NXOpen.Motion.ConnectorCoefficientTypes) –New in version NX8.5.0.
License requirements: mechanisms (“MECHANISMS”)
CreateDamper¶
-
SpringBuilder.CreateDamper¶ Returns or sets the create damper toggle
-------------------------------------Getter Method
Signature
CreateDamper()Returns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CreateDamper(createDamper)Parameters: createDamper (bool) – New in version NX8.5.0.
License requirements: None.
DamperName¶
-
SpringBuilder.DamperName¶ Returns or sets the damper dname
-------------------------------------Getter Method
Signature
DamperName()Returns: Return type: str New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DamperName(damperName)Parameters: damperName (str) – New in version NX8.5.0.
License requirements: mechanisms (“MECHANISMS”)
FreeAngleExpression¶
-
SpringBuilder.FreeAngleExpression¶ Returns the free angle expression
-------------------------------------Getter Method
Signature
FreeAngleExpression()Returns: Return type: NXOpen.ExpressionNew in version NX8.0.0.
Deprecated since version NX11.0.0: Obtian the expression using
Motion.SpringBuilder.PreloadedAngleExpression()to query or edit it.License requirements: None.
FreeLength¶
-
SpringBuilder.FreeLength¶ Returns or sets the free length
-------------------------------------Getter Method
Signature
FreeLength()Returns: Return type: float New in version NX6.0.0.
Deprecated since version NX8.0.0: Obtain the expression using
Motion.SpringBuilder.FreeLengthExpression()orMotion.SpringBuilder.FreeLengthExpression()to query or edit it.License requirements: None.
-------------------------------------Setter Method
Signature
FreeLength(freeLength)Parameters: freeLength (float) – New in version NX6.0.0.
Deprecated since version NX8.0.0: Obtain the expression using
Motion.SpringBuilder.FreeLengthExpression()orMotion.SpringBuilder.FreeLengthExpression()to query or edit it.License requirements: mechanisms (“MECHANISMS”)
FreeLengthExpression¶
-
SpringBuilder.FreeLengthExpression¶ Returns the free length expression
-------------------------------------Getter Method
Signature
FreeLengthExpression()Returns: Return type: NXOpen.ExpressionNew in version NX8.0.0.
Deprecated since version NX11.0.0: Obtian the expression using
Motion.SpringBuilder.PreloadedLengthExpression()to query or edit it.License requirements: None.
InitialLength¶
-
SpringBuilder.InitialLength¶ Returns or sets the initial length used for spring attached to slide joint
-------------------------------------Getter Method
Signature
InitialLength()Returns: Return type: float New in version NX6.0.0.
Deprecated since version NX8.0.0: Obtian the expression using
Motion.SpringBuilder.InitialLengthExpression()to query or edit it.License requirements: None.
-------------------------------------Setter Method
Signature
InitialLength(initialLength)Parameters: initialLength (float) – New in version NX6.0.0.
Deprecated since version NX8.0.0: Obtian the expression using
Motion.SpringBuilder.InitialLengthExpression()to query or edit it.License requirements: mechanisms (“MECHANISMS”)
InitialLengthExpression¶
-
SpringBuilder.InitialLengthExpression¶ Returns the initial length expression for spring which attachs to slide joint
-------------------------------------Getter Method
Signature
InitialLengthExpression()Returns: Return type: NXOpen.ExpressionNew in version NX8.0.0.
License requirements: None.
LengthFlag¶
-
SpringBuilder.LengthFlag¶ Returns or sets the length flag, if this flag is set to true, it will not update the preloaded length, if this flag is set to false, it will update the preloaded length according to the installed length
-------------------------------------Getter Method
Signature
LengthFlag()Returns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
LengthFlag(lengthFlag)Parameters: lengthFlag (bool) – New in version NX8.5.0.
License requirements: mechanisms (“MECHANISMS”)
Name¶
-
SpringBuilder.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”)
PreloadAngleExpression¶
-
SpringBuilder.PreloadAngleExpression¶ Returns the preload expression
-------------------------------------Getter Method
Signature
PreloadAngleExpression()Returns: Return type: NXOpen.ExpressionNew in version NX8.5.0.
Deprecated since version NX11.0.0: Obtian the expression using
Motion.SpringBuilder.PreloadMomentExpression()to query or edit it.License requirements: None.
PreloadExpression¶
-
SpringBuilder.PreloadExpression¶ Returns the preload expression
-------------------------------------Getter Method
Signature
PreloadExpression()Returns: Return type: NXOpen.ExpressionNew in version NX8.5.0.
Deprecated since version NX11.0.0: Obtian the expression using
Motion.SpringBuilder.PreloadForceExpression()to query or edit it.License requirements: None.
PreloadForceExpression¶
-
SpringBuilder.PreloadForceExpression¶ Returns the preload force expression
-------------------------------------Getter Method
Signature
PreloadForceExpression()Returns: Return type: NXOpen.ExpressionNew in version NX11.0.0.
License requirements: None.
PreloadMomentExpression¶
-
SpringBuilder.PreloadMomentExpression¶ Returns the preload moment expression
-------------------------------------Getter Method
Signature
PreloadMomentExpression()Returns: Return type: NXOpen.ExpressionNew in version NX11.0.0.
License requirements: None.
PreloadedAngleExpression¶
-
SpringBuilder.PreloadedAngleExpression¶ Returns the preloaded angle expression
-------------------------------------Getter Method
Signature
PreloadedAngleExpression()Returns: Return type: NXOpen.ExpressionNew in version NX11.0.0.
License requirements: None.
PreloadedLengthExpression¶
-
SpringBuilder.PreloadedLengthExpression¶ Returns the preloaded length expression
-------------------------------------Getter Method
Signature
PreloadedLengthExpression()Returns: Return type: NXOpen.ExpressionNew in version NX11.0.0.
License requirements: None.
Stiffness¶
-
SpringBuilder.Stiffness¶ Returns or sets the stiffness.
Only valid if
MotionConnectorCoefficientTypes.Constantis set-------------------------------------Getter Method
Signature
Stiffness()Returns: Return type: float New in version NX6.0.0.
Deprecated since version NX8.0.0: Obtain the expression using
Motion.SpringBuilder.Stiffness()andMotion.SpringBuilder.TorsionalStiffnessExpression()to query or edit it.License requirements: None.
-------------------------------------Setter Method
Signature
Stiffness(stiffness)Parameters: stiffness (float) – New in version NX6.0.0.
Deprecated since version NX8.0.0: Obtain the expression using
Motion.SpringBuilder.Stiffness()andMotion.SpringBuilder.TorsionalStiffnessExpression()to query or edit it.License requirements: mechanisms (“MECHANISMS”)
StiffnessExpression¶
-
SpringBuilder.StiffnessExpression¶ Returns the stiffness expression
-------------------------------------Getter Method
Signature
StiffnessExpression()Returns: Return type: NXOpen.ExpressionNew in version NX8.0.0.
License requirements: None.
StiffnessFunction¶
-
SpringBuilder.StiffnessFunction¶ Returns or sets the function tag.
Only valid if
MotionConnectorCoefficientTypes.Splineis set-------------------------------------Getter Method
Signature
StiffnessFunction()Returns: Return type: NXOpen.CAE.FunctionNew in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
StiffnessFunction(function)Parameters: function ( NXOpen.CAE.Function) –New in version NX6.0.0.
License requirements: mechanisms (“MECHANISMS”)
StiffnessType¶
-
SpringBuilder.StiffnessType¶ Returns or sets the stiffness type
-------------------------------------Getter Method
Signature
StiffnessType()Returns: Return type: NXOpen.Motion.ConnectorCoefficientTypesNew in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
StiffnessType(stiffnessType)Parameters: stiffnessType ( NXOpen.Motion.ConnectorCoefficientTypes) –New in version NX6.0.0.
License requirements: mechanisms (“MECHANISMS”)
TorsionalCoefficientExpression¶
-
SpringBuilder.TorsionalCoefficientExpression¶ Returns the torsional coefficient expression
-------------------------------------Getter Method
Signature
TorsionalCoefficientExpression()Returns: Return type: NXOpen.ExpressionNew in version NX8.5.0.
License requirements: None.
TorsionalStiffnessExpression¶
-
SpringBuilder.TorsionalStiffnessExpression¶ Returns the torsional stiffness expression
-------------------------------------Getter Method
Signature
TorsionalStiffnessExpression()Returns: Return type: NXOpen.ExpressionNew in version NX8.0.0.
License requirements: None.
Method Detail¶
Validate¶
-
SpringBuilder.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.