SpringBuilder Class¶
-
class
NXOpen.Motion.
SpringBuilder
¶ Bases:
NXOpen.Motion.ConnectorBuilder
Represents a SpringBuilder
To create a new instance of this class, use
NXOpen.Motion.SpringCollection.CreateSpringBuilder()
Default values.
Property Value StiffnessType Constant New in version NX6.0.0.
Properties¶
Property | Description |
---|---|
ActionLink | Returns the action link. |
ActionPoint | Returns or sets the action point. |
ActuatorCurveProfile | Returns the actuator profile. |
ActuatorForceExpression | Returns the actuator force expression |
ActuatorFunction | Returns or sets the actuator function tag. |
ActuatorMomentExpression | Returns the actuator moment expression |
ActuatorType | Returns or sets the actuator spline type |
Attachment | Returns or sets the attachment type |
CoefficientCurveProfile | Returns the coefficient profile |
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 |
DamperAppDirection | Returns or sets the application direction of damper |
DamperCustomizedSolver | Returns or sets the option of using Customized Solver for damper |
DamperName | Returns or sets the damper dname |
DisplayScale | Returns or sets the icon display scale |
FreeAngleExpression | Returns the free angle expression |
FreeLengthExpression | Returns the free length expression |
GroupName | Returns or sets the group name |
GroupType | Returns or sets the group type |
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. |
SpringAppDirection | Returns or sets the application direction for damper |
SpringCustomizedSolver | Returns or sets the option of using Customized Solver for damper |
StiffnessCurveProfile | Returns the stiffness 2D profile. |
StiffnessExpression | Returns the stiffness expression |
StiffnessFunction | Returns or sets the function tag. |
StiffnessSurfaceProfile | Returns the stiffness 3D profile. |
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¶
ActuatorCurveProfile¶
-
SpringBuilder.
ActuatorCurveProfile
¶ Returns the actuator profile.
Only valid if
MotionConnectorCoefficientTypes.Profile2d
orMotionConnectorCoefficientTypes.ExpressionAndProfile2d
is set-------------------------------------
Getter Method
Signature
ActuatorCurveProfile
Returns: Return type: NXOpen.Motion.SelectFieldData
New in version NX12.0.0.
License requirements: None.
ActuatorForceExpression¶
-
SpringBuilder.
ActuatorForceExpression
¶ Returns the actuator force expression
-------------------------------------
Getter Method
Signature
ActuatorForceExpression
Returns: Return type: NXOpen.Expression
New in version NX12.0.0.
License requirements: None.
ActuatorFunction¶
-
SpringBuilder.
ActuatorFunction
¶ Returns or sets the actuator function tag.
-------------------------------------
Getter Method
Signature
ActuatorFunction
Returns: Return type: NXOpen.CAE.Function
New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ActuatorFunction
Parameters: actuatorFunction ( NXOpen.CAE.Function
) –New in version NX12.0.0.
License requirements: mechanisms (“MECHANISMS”)
ActuatorMomentExpression¶
-
SpringBuilder.
ActuatorMomentExpression
¶ Returns the actuator moment expression
-------------------------------------
Getter Method
Signature
ActuatorMomentExpression
Returns: Return type: NXOpen.Expression
New in version NX12.0.0.
License requirements: None.
ActuatorType¶
-
SpringBuilder.
ActuatorType
¶ Returns or sets the actuator spline type
-------------------------------------
Getter Method
Signature
ActuatorType
Returns: Return type: NXOpen.Motion.ConnectorCoefficientTypes
New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ActuatorType
Parameters: actuatorType ( NXOpen.Motion.ConnectorCoefficientTypes
) –New in version NX12.0.0.
License requirements: mechanisms (“MECHANISMS”)
CoefficientCurveProfile¶
-
SpringBuilder.
CoefficientCurveProfile
¶ Returns the coefficient profile
-------------------------------------
Getter Method
Signature
CoefficientCurveProfile
Returns: Return type: NXOpen.Motion.SelectFieldData
New in version NX12.0.0.
License requirements: None.
CoefficientExpression¶
-
SpringBuilder.
CoefficientExpression
¶ Returns the translational coefficient expression
-------------------------------------
Getter Method
Signature
CoefficientExpression
Returns: Return type: NXOpen.Expression
New in version NX8.5.0.
License requirements: None.
CoefficientFunction¶
-
SpringBuilder.
CoefficientFunction
¶ Returns or sets the function tag.
Only valid if
MotionConnectorCoefficientTypes.Spline
is set-------------------------------------
Getter Method
Signature
CoefficientFunction
Returns: Return type: NXOpen.CAE.Function
New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CoefficientFunction
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.ConnectorCoefficientTypes
New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
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
Parameters: createDamper (bool) – New in version NX8.5.0.
License requirements: None.
DamperAppDirection¶
-
SpringBuilder.
DamperAppDirection
¶ Returns or sets the application direction of damper
-------------------------------------
Getter Method
Signature
DamperAppDirection
Returns: Return type: NXOpen.Motion.ConnectorBuilderApplicationDirection
New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DamperAppDirection
Parameters: appDirection ( NXOpen.Motion.ConnectorBuilderApplicationDirection
) –New in version NX12.0.0.
License requirements: mechanisms (“MECHANISMS”)
DamperCustomizedSolver¶
-
SpringBuilder.
DamperCustomizedSolver
¶ Returns or sets the option of using Customized Solver for damper
-------------------------------------
Getter Method
Signature
DamperCustomizedSolver
Returns: Return type: bool New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DamperCustomizedSolver
Parameters: customizedSolver (bool) – New in version NX12.0.0.
License requirements: mechanisms (“MECHANISMS”)
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
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.Expression
New in version NX8.0.0.
Deprecated since version NX11.0.0: Obtain the expression using
Motion.SpringBuilder.PreloadedAngleExpression()
to query or edit it.License requirements: None.
FreeLengthExpression¶
-
SpringBuilder.
FreeLengthExpression
¶ Returns the free length expression
-------------------------------------
Getter Method
Signature
FreeLengthExpression
Returns: Return type: NXOpen.Expression
New in version NX8.0.0.
Deprecated since version NX11.0.0: Obtain the expression using
Motion.SpringBuilder.PreloadedLengthExpression()
to query or edit it.License requirements: None.
InitialLengthExpression¶
-
SpringBuilder.
InitialLengthExpression
¶ Returns the initial length expression for spring which attachs to slide joint
-------------------------------------
Getter Method
Signature
InitialLengthExpression
Returns: Return type: NXOpen.Expression
New 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
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
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.Expression
New in version NX8.5.0.
Deprecated since version NX11.0.0: Obtain the expression using
Motion.SpringBuilder.ActuatorMomentExpression()
to query or edit it.License requirements: None.
PreloadExpression¶
-
SpringBuilder.
PreloadExpression
¶ Returns the preload expression
-------------------------------------
Getter Method
Signature
PreloadExpression
Returns: Return type: NXOpen.Expression
New in version NX8.5.0.
Deprecated since version NX11.0.0: Obtain the expression using
Motion.SpringBuilder.ActuatorForceExpression()
to query or edit it.License requirements: None.
PreloadForceExpression¶
-
SpringBuilder.
PreloadForceExpression
¶ Returns the preload force expression
-------------------------------------
Getter Method
Signature
PreloadForceExpression
Returns: Return type: NXOpen.Expression
New in version NX11.0.0.
Deprecated since version NX12.0.0: Obtain the expression using
Motion.SpringBuilder.ActuatorForceExpression()
to query or edit it.License requirements: None.
PreloadMomentExpression¶
-
SpringBuilder.
PreloadMomentExpression
¶ Returns the preload moment expression
-------------------------------------
Getter Method
Signature
PreloadMomentExpression
Returns: Return type: NXOpen.Expression
New in version NX11.0.0.
Deprecated since version NX12.0.0: Obtain the expression using
Motion.SpringBuilder.ActuatorMomentExpression()
to query or edit it.License requirements: None.
PreloadedAngleExpression¶
-
SpringBuilder.
PreloadedAngleExpression
¶ Returns the preloaded angle expression
-------------------------------------
Getter Method
Signature
PreloadedAngleExpression
Returns: Return type: NXOpen.Expression
New in version NX11.0.0.
License requirements: None.
PreloadedLengthExpression¶
-
SpringBuilder.
PreloadedLengthExpression
¶ Returns the preloaded length expression
-------------------------------------
Getter Method
Signature
PreloadedLengthExpression
Returns: Return type: NXOpen.Expression
New in version NX11.0.0.
License requirements: None.
SpringAppDirection¶
-
SpringBuilder.
SpringAppDirection
¶ Returns or sets the application direction for damper
-------------------------------------
Getter Method
Signature
SpringAppDirection
Returns: Return type: NXOpen.Motion.ConnectorBuilderApplicationDirection
New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SpringAppDirection
Parameters: springAppDirection ( NXOpen.Motion.ConnectorBuilderApplicationDirection
) –New in version NX12.0.0.
License requirements: mechanisms (“MECHANISMS”)
SpringCustomizedSolver¶
-
SpringBuilder.
SpringCustomizedSolver
¶ Returns or sets the option of using Customized Solver for damper
-------------------------------------
Getter Method
Signature
SpringCustomizedSolver
Returns: Return type: bool New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SpringCustomizedSolver
Parameters: springCustomizedSolver (bool) – New in version NX12.0.0.
License requirements: mechanisms (“MECHANISMS”)
StiffnessCurveProfile¶
-
SpringBuilder.
StiffnessCurveProfile
¶ Returns the stiffness 2D profile.
Only valid if
MotionConnectorCoefficientTypes.Profile2d
orMotionConnectorCoefficientTypes.ExpressionAndProfile2d
is set.-------------------------------------
Getter Method
Signature
StiffnessCurveProfile
Returns: Return type: NXOpen.Motion.SelectFieldData
New in version NX12.0.0.
License requirements: None.
StiffnessExpression¶
-
SpringBuilder.
StiffnessExpression
¶ Returns the stiffness expression
-------------------------------------
Getter Method
Signature
StiffnessExpression
Returns: Return type: NXOpen.Expression
New in version NX8.0.0.
License requirements: None.
StiffnessFunction¶
-
SpringBuilder.
StiffnessFunction
¶ Returns or sets the function tag.
On Adams and Recurdyn, only valid if
MotionConnectorCoefficientTypes.Spline
is set-------------------------------------
Getter Method
Signature
StiffnessFunction
Returns: Return type: NXOpen.CAE.Function
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
StiffnessFunction
Parameters: function ( NXOpen.CAE.Function
) –New in version NX6.0.0.
License requirements: mechanisms (“MECHANISMS”)
StiffnessSurfaceProfile¶
-
SpringBuilder.
StiffnessSurfaceProfile
¶ Returns the stiffness 3D profile.
Only valid if
MotionConnectorCoefficientTypes.Profile3d
orMotionConnectorCoefficientTypes.ExpressionAndProfile3d
is set.-------------------------------------
Getter Method
Signature
StiffnessSurfaceProfile
Returns: Return type: NXOpen.Motion.SelectFieldData
New in version NX12.0.0.
License requirements: None.
StiffnessType¶
-
SpringBuilder.
StiffnessType
¶ Returns or sets the stiffness type
-------------------------------------
Getter Method
Signature
StiffnessType
Returns: Return type: NXOpen.Motion.ConnectorCoefficientTypes
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
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.Expression
New in version NX8.5.0.
License requirements: None.
TorsionalStiffnessExpression¶
-
SpringBuilder.
TorsionalStiffnessExpression
¶ Returns the torsional stiffness expression
-------------------------------------
Getter Method
Signature
TorsionalStiffnessExpression
Returns: Return type: NXOpen.Expression
New 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.