RmsResultsEvaluationSettingBuilder Class¶
-
class
NXOpen.CAE.ResponseSimulation.RmsResultsEvaluationSettingBuilder¶ Bases:
NXOpen.CAE.ResponseSimulation.PrlResultsEvaluationSettingBuilderThis is a manager to the
NXOpen.CAE.ResponseSimulation.RmsResultsEvaluationSettingclass.Object of type
NXOpen.CAE.ResponseSimulation.RmsResultsEvaluationSettingcan be created and edited only through this classTo create a new instance of this class, use
NXOpen.CAE.ResponseSimulation.EvaluationSettingManager.CreateRmsResultsEvaluationSettingBuilder()New in version NX5.0.0.
Properties¶
| Property | Description |
|---|---|
| CoordinateSystem | Returns or sets the coordinate system. |
| EvaluationMethod | Returns or sets the evaluation method for RMS |
| ObservationNode | Returns or sets the relative node. |
| Relative | Returns or sets the option of using the observation node in evaluation |
| ResultType | Returns or sets the result type |
| Tag | Returns the Tag for this object. |
| UserDefinedDirection | Returns or sets the user defined direction |
| UsingUserDefinedDirection | Returns or sets the option of using user defined direction |
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. |
| GetDataComponents | Returns the direction data components. |
| GetDescriptionString | Returns the description. |
| GetObject | Returns the object currently being edited by this builder. |
| GetOutputElements | Returns the destination elements. |
| GetOutputNodes | Returns the destination nodes. |
| SetDataComponents | Sets the direction data components. |
| SetDescriptionString | Sets the description |
| SetOutputElements | Sets the destination elements |
| SetOutputNodes | Sets the destination nodes |
| 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¶
EvaluationMethod¶
-
RmsResultsEvaluationSettingBuilder.EvaluationMethod¶ Returns or sets the evaluation method for RMS
-------------------------------------Getter Method
Signature
EvaluationMethodReturns: Return type: NXOpen.CAE.ResponseSimulation.RmsLcrEvaluationMethodNew in version NX8.5.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
-------------------------------------Setter Method
Signature
EvaluationMethodParameters: evaluationMethod ( NXOpen.CAE.ResponseSimulation.RmsLcrEvaluationMethod) –New in version NX8.5.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
UserDefinedDirection¶
-
RmsResultsEvaluationSettingBuilder.UserDefinedDirection¶ Returns or sets the user defined direction
-------------------------------------Getter Method
Signature
UserDefinedDirectionReturns: Return type: NXOpen.DirectionNew in version NX5.0.0.
Deprecated since version NX8.5.0: This method is not used any more and there is no replacement for it.
License requirements: nx_response_anlys (“NX Response Analysis”)
-------------------------------------Setter Method
Signature
UserDefinedDirectionParameters: userDefinedDirection ( NXOpen.Direction) –New in version NX5.0.0.
Deprecated since version NX8.5.0: This method is not used any more and there is no replacement for it.
License requirements: nx_response_anlys (“NX Response Analysis”)
UsingUserDefinedDirection¶
-
RmsResultsEvaluationSettingBuilder.UsingUserDefinedDirection¶ Returns or sets the option of using user defined direction
-------------------------------------Getter Method
Signature
UsingUserDefinedDirectionReturns: Return type: bool New in version NX5.0.0.
Deprecated since version NX8.5.0: This method is not used any more and there is no replacement for it.
License requirements: nx_response_anlys (“NX Response Analysis”)
-------------------------------------Setter Method
Signature
UsingUserDefinedDirectionParameters: usingUserDefinedDirection (bool) – New in version NX5.0.0.
Deprecated since version NX8.5.0: This method is not used any more and there is no replacement for it.
License requirements: nx_response_anlys (“NX Response Analysis”)
Method Detail¶
Validate¶
-
RmsResultsEvaluationSettingBuilder.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.