DDAMExcitationBuilder Class¶
-
class
NXOpen.CAE.ResponseSimulation.DDAMExcitationBuilder¶ Bases:
NXOpen.CAE.ResponseSimulation.ExcitationBuilderRepresents the manager to
NXOpen.CAE.ResponseSimulation.DDAMExcitation.The object of type
NXOpen.CAE.ResponseSimulation.DDAMExcitationcan only be created or edited through this class. To create a new instance of this class, useNXOpen.CAE.ResponseSimulation.ExcitationCollection.CreateDdamExcitationBuilder()New in version NX5.0.0.
Properties¶
| Property | Description |
|---|---|
| DynamicEvent | Returns the parent dynamic event object |
| ExcitationLocationDefinition | Returns the excitation location definition |
| LoadingType | Returns or sets the loading type |
| ObjectLabel | Returns the object label |
| ResponseType | Returns or sets the response type |
| 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. |
| GetComponentStatus | Returns the status of a dierction component |
| GetObject | Returns the object currently being edited by this builder. |
| SetComponentStatus | Sets the status for a direction component |
| 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¶
LoadingType¶
-
DDAMExcitationBuilder.LoadingType¶ Returns or sets the loading type
-------------------------------------Getter Method
Signature
LoadingTypeReturns: Return type: NXOpen.CAE.ResponseSimulation.DDAMExcitationLoadingTypeNew in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
-------------------------------------Setter Method
Signature
LoadingTypeParameters: loadingType ( NXOpen.CAE.ResponseSimulation.DDAMExcitationLoadingType) –New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
ResponseType¶
-
DDAMExcitationBuilder.ResponseType¶ Returns or sets the response type
-------------------------------------Getter Method
Signature
ResponseTypeReturns: Return type: NXOpen.CAE.ResponseSimulation.DDAMExcitationResponseTypeNew in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
-------------------------------------Setter Method
Signature
ResponseTypeParameters: responseType ( NXOpen.CAE.ResponseSimulation.DDAMExcitationResponseType) –New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
Method Detail¶
GetComponentStatus¶
-
DDAMExcitationBuilder.GetComponentStatus¶ Returns the status of a dierction component
Signature
GetComponentStatus(component)Parameters: component ( NXOpen.CAE.ResponseSimulation.ExcitationComponent) –Returns: Return type: bool New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
SetComponentStatus¶
-
DDAMExcitationBuilder.SetComponentStatus¶ Sets the status for a direction component
Signature
SetComponentStatus(component, enable)Parameters: - component (
NXOpen.CAE.ResponseSimulation.ExcitationComponent) – - enable (bool) –
New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
- component (
Validate¶
-
DDAMExcitationBuilder.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.