DamperBuilder Class¶
-
class
NXOpen.Motion.
DamperBuilder
¶ Bases:
NXOpen.Motion.ConnectorBuilder
Represents a DamperBuilder
To create a new instance of this class, use
NXOpen.Motion.DamperCollection.CreateDamperBuilder()
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 |
Coefficient | Returns or sets the coefficient. |
CoefficientExpression | Returns the translational coefficient expression |
CoefficientFunction | Returns or sets the function tag. |
CoefficientType | Returns or sets the coefficient type |
DisplayScale | Returns or sets the icon display scale |
GroupName | Returns or sets the group name |
GroupType | Returns or sets the group type |
Joint | Returns the joint . |
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. |
TorsionalCoefficientExpression | Returns the torsional coefficient 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¶
Coefficient¶
-
DamperBuilder.
Coefficient
¶ Returns or sets the coefficient.
Only valid if
MotionConnectorCoefficientTypes.Constant
is set-------------------------------------
Getter Method
Signature
Coefficient()
Returns: Return type: float New in version NX6.0.0.
Deprecated since version NX8.0.0: Obtain the expression using
Motion.DamperBuilder.CoefficientExpression()
orMotion.DamperBuilder.TorsionalCoefficientExpression()
to query or edit it.License requirements: None.
-------------------------------------
Setter Method
Signature
Coefficient(coefficient)
Parameters: coefficient (float) – New in version NX6.0.0.
Deprecated since version NX8.0.0: Obtain the expression using
Motion.DamperBuilder.CoefficientExpression()
orMotion.DamperBuilder.TorsionalCoefficientExpression()
to query or edit it.License requirements: mechanisms (“MECHANISMS”)
CoefficientExpression¶
-
DamperBuilder.
CoefficientExpression
¶ Returns the translational coefficient expression
-------------------------------------
Getter Method
Signature
CoefficientExpression()
Returns: Return type: NXOpen.Expression
New in version NX8.0.0.
License requirements: None.
CoefficientFunction¶
-
DamperBuilder.
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 NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CoefficientFunction(function)
Parameters: function ( NXOpen.CAE.Function
) –New in version NX6.0.0.
License requirements: mechanisms (“MECHANISMS”)
CoefficientType¶
-
DamperBuilder.
CoefficientType
¶ Returns or sets the coefficient type
-------------------------------------
Getter Method
Signature
CoefficientType()
Returns: Return type: NXOpen.Motion.ConnectorCoefficientTypes
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CoefficientType(coefficientType)
Parameters: coefficientType ( NXOpen.Motion.ConnectorCoefficientTypes
) –New in version NX6.0.0.
License requirements: mechanisms (“MECHANISMS”)
Name¶
-
DamperBuilder.
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”)
TorsionalCoefficientExpression¶
-
DamperBuilder.
TorsionalCoefficientExpression
¶ Returns the torsional coefficient expression
-------------------------------------
Getter Method
Signature
TorsionalCoefficientExpression()
Returns: Return type: NXOpen.Expression
New in version NX8.0.0.
License requirements: None.
Method Detail¶
Validate¶
-
DamperBuilder.
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.