RSEventBuilder Class¶
-
class
NXOpen.CAE.ResponseSimulation.RSEventBuilder¶ Bases:
NXOpen.CAE.ResponseSimulation.BaseBuilderRepresents the manager of CAE.
ResponseSimulation.RSEvent. The object of type
NXOpen.CAE.ResponseSimulation.RSEventcan be created or deleted only through this class. To create a new instance of this class, useNXOpen.CAE.ResponseSimulation.RSEventCollection.CreateEventBuilder()New in version NX5.0.0.
Properties¶
| Property | Description |
|---|---|
| Attributes | Returns the attributes setting |
| EventType | Returns or sets the event type |
| InitialConditions | Returns the initial condition setting. |
| ObjectLabel | Returns the object label |
| OutputSetting | Returns the output setting |
| ResponseSimulationSolution | Returns the parent response simulation solution |
| 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¶
Attributes¶
-
RSEventBuilder.Attributes¶ Returns the attributes setting
-------------------------------------Getter Method
Signature
AttributesReturns: Return type: NXOpen.CAE.ResponseSimulation.RSEventAttributesNew in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
EventType¶
-
RSEventBuilder.EventType¶ Returns or sets the event type
-------------------------------------Getter Method
Signature
EventTypeReturns: Return type: NXOpen.CAE.ResponseSimulation.RSEventTypeNew in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
-------------------------------------Setter Method
Signature
EventTypeParameters: eventType ( NXOpen.CAE.ResponseSimulation.RSEventType) –New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
InitialConditions¶
-
RSEventBuilder.InitialConditions¶ Returns the initial condition setting.
Only available when event type is
NXOpen.CAE.ResponseSimulation.RSEventType.Transient-------------------------------------Getter Method
Signature
InitialConditionsReturns: Return type: NXOpen.CAE.ResponseSimulation.InitialConditionsNew in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
OutputSetting¶
-
RSEventBuilder.OutputSetting¶ Returns the output setting
-------------------------------------Getter Method
Signature
OutputSettingReturns: Return type: NXOpen.CAE.ResponseSimulation.RSEventOutputSettingNew in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
ResponseSimulationSolution¶
-
RSEventBuilder.ResponseSimulationSolution¶ Returns the parent response simulation solution
-------------------------------------Getter Method
Signature
ResponseSimulationSolutionReturns: Return type: NXOpen.CAE.ResponseSimulation.SolutionNew in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
Method Detail¶
Validate¶
-
RSEventBuilder.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.