ExcitationBuilder Class¶
-
class
NXOpen.CAE.ResponseSimulation.
ExcitationBuilder
¶ Bases:
NXOpen.CAE.ResponseSimulation.BaseBuilder
Represents the abstract excitation builder class.
Any of real excitation builder must inherit from this class.
This is an abstract class, and cannot be created.
New in version NX5.0.0.
Properties¶
Property | Description |
---|---|
DynamicEvent | Returns the parent dynamic event object |
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. |
Enumerations¶
ExcitationBuilderExcitationLocationType Enumeration | the type of excitation location |
Property Detail¶
DynamicEvent¶
-
ExcitationBuilder.
DynamicEvent
¶ Returns the parent dynamic event object
-------------------------------------
Getter Method
Signature
DynamicEvent()
Returns: Return type: NXOpen.CAE.ResponseSimulation.RSEvent
New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
ExcitationLocationDefinition¶
-
ExcitationBuilder.
ExcitationLocationDefinition
¶ Returns the excitation location definition
-------------------------------------
Getter Method
Signature
ExcitationLocationDefinition()
Returns: Return type: NXOpen.CAE.ResponseSimulation.ExcitationLocationDefinition
New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
Method Detail¶
Validate¶
-
ExcitationBuilder.
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.