DistributedLoadExcitationBuilder Class¶
-
class
NXOpen.CAE.ResponseSimulation.
DistributedLoadExcitationBuilder
¶ Bases:
NXOpen.CAE.ResponseSimulation.ExcitationBuilder
Represents the manager to
NXOpen.CAE.ResponseSimulation.DistributedLoadExcitation
.The object of type
NXOpen.CAE.ResponseSimulation.DistributedLoadExcitation
can only be created or edited through this class.To create a new instance of this class, use
NXOpen.CAE.ResponseSimulation.ExcitationCollection.CreateDistributedLoadExcitationBuilder
New in version NX5.0.0.
Properties¶
Property | Description |
---|---|
DynamicEvent | Returns the parent dynamic event object |
ExcitationFunction | Returns the magnitude function |
ExcitationLocationDefinition | Returns the excitation location definition |
ObjectLabel | Returns the object label |
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¶
ExcitationFunction¶
-
DistributedLoadExcitationBuilder.
ExcitationFunction
¶ Returns the magnitude function
-------------------------------------
Getter Method
Signature
ExcitationFunction()
Returns: Return type: NXOpen.CAE.ResponseSimulation.FunctionComponentData
New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
Method Detail¶
Validate¶
-
DistributedLoadExcitationBuilder.
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.