DurabilityFunctionExcitationBuilder Class¶
-
class
NXOpen.CAE.
DurabilityFunctionExcitationBuilder
¶ Bases:
NXOpen.CAE.DurabilityExcitationBuilder
Represents a
NXOpen.CAE.DurabilityFunctionExcitation
builder.There is no kf creator for this.
New in version NX8.5.0.
Properties¶
Property | Description |
---|---|
ExcitationName | Returns or sets the excitation name. |
Function | Returns or sets the function. |
Iteration | Returns or sets the iteration. |
Loadcase | Returns or sets the load case. |
Offset | Returns or sets the offset. |
Scale | Returns or sets the scale. |
Tag | Returns the Tag for this object. |
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¶
Function¶
-
DurabilityFunctionExcitationBuilder.
Function
¶ Returns or sets the function.
-------------------------------------
Getter Method
Signature
Function()
Returns: Return type: NXOpen.TaggedObject
New in version NX8.5.0.
License requirements: nx_adv_durability (“NX Advanced Durability”)
-------------------------------------
Setter Method
Signature
Function(functionTag)
Parameters: functionTag ( NXOpen.TaggedObject
) –New in version NX8.5.0.
License requirements: nx_adv_durability (“NX Advanced Durability”)
Iteration¶
-
DurabilityFunctionExcitationBuilder.
Iteration
¶ Returns or sets the iteration.
-------------------------------------
Getter Method
Signature
Iteration()
Returns: Return type: int New in version NX9.0.0.
License requirements: nx_adv_durability (“NX Advanced Durability”)
-------------------------------------
Setter Method
Signature
Iteration(iteration)
Parameters: iteration (int) – New in version NX9.0.0.
License requirements: nx_adv_durability (“NX Advanced Durability”)
Loadcase¶
-
DurabilityFunctionExcitationBuilder.
Loadcase
¶ Returns or sets the load case.
-------------------------------------
Getter Method
Signature
Loadcase()
Returns: Return type: int New in version NX8.5.0.
License requirements: nx_adv_durability (“NX Advanced Durability”)
-------------------------------------
Setter Method
Signature
Loadcase(loadcase)
Parameters: loadcase (int) – New in version NX8.5.0.
License requirements: nx_adv_durability (“NX Advanced Durability”)
Offset¶
-
DurabilityFunctionExcitationBuilder.
Offset
¶ Returns or sets the offset.
-------------------------------------
Getter Method
Signature
Offset()
Returns: Return type: float New in version NX8.5.0.
License requirements: nx_adv_durability (“NX Advanced Durability”)
-------------------------------------
Setter Method
Signature
Offset(offset)
Parameters: offset (float) – New in version NX8.5.0.
License requirements: nx_adv_durability (“NX Advanced Durability”)
Scale¶
-
DurabilityFunctionExcitationBuilder.
Scale
¶ Returns or sets the scale.
-------------------------------------
Getter Method
Signature
Scale()
Returns: Return type: float New in version NX8.5.0.
License requirements: nx_adv_durability (“NX Advanced Durability”)
-------------------------------------
Setter Method
Signature
Scale(scale)
Parameters: scale (float) – New in version NX8.5.0.
License requirements: nx_adv_durability (“NX Advanced Durability”)
Method Detail¶
Validate¶
-
DurabilityFunctionExcitationBuilder.
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.